Rules: create

Memerlukan otorisasi

Membuat aturan GTM. Coba sekarang atau lihat contohnya.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/rules

Parameter

Nama parameter Nilai Deskripsi
Parameter jalur
accountId string ID Akun GTM.
containerId string ID Penampung GTM.

Otorisasi

Permintaan ini memerlukan otorisasi dengan cakupan berikut (baca selengkapnya tentang autentikasi dan otorisasi).

Cakupan
https://www.googleapis.com/auth/tagmanager.edit.containers

Isi permintaan

Dalam isi permintaan, berikan resource Aturan dengan properti berikut:

Nama properti Nilai Deskripsi Catatan
Properti yang Diperlukan
condition[].parameter[] list Daftar parameter bernama (kunci/nilai), bergantung pada jenis kondisi. Catatan:
  • Untuk operator biner, sertakan parameter bernama arg0 dan arg1 untuk menentukan operand kiri dan kanan.
  • Pada saat ini, operand kiri (arg0) harus menjadi referensi ke makro.
  • Untuk pencocokan Ekspresi Reguler yang tidak peka huruf besar/kecil, sertakan parameter boolean bernama ignore_case yang disetel ke true. Jika tidak ditentukan atau ditetapkan ke nilai lain, pencocokan akan peka huruf besar/kecil.
  • Untuk menegasikan operator, sertakan parameter Boolean bernama negate dan tetapkan ke true.
dapat ditulis
condition[].parameter[].type string Jenis parameter. Nilai yang valid adalah:
  • boolean: Nilai mewakili boolean, yang diwakili sebagai 'true' atau 'false'
  • integer: Nilai mewakili nilai bilangan bulat dengan tanda tangan 64-bit, di basis 10
  • list: Daftar parameter harus ditentukan
  • map: Peta parameter harus ditentukan
  • template: Nilai mewakili teks apa pun; nilai ini dapat mencakup referensi makro (bahkan referensi makro yang mungkin menampilkan jenis non-string)


Nilai yang dapat diterima:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
dapat ditulis
condition[].type string Jenis operator untuk kondisi ini.

Nilai yang dapat diterima adalah:
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
dapat ditulis
name string Nama tampilan aturan. dapat ditulis
Properti Opsional
condition[] list Daftar kondisi yang membentuk aturan ini (DAN implisit di antara keduanya). dapat ditulis
condition[].parameter[].key string Kunci bernama yang mengidentifikasi parameter secara unik. Diperlukan untuk parameter tingkat teratas, serta nilai peta. Diabaikan untuk nilai daftar. dapat ditulis
condition[].parameter[].list[] list Parameter parameter daftar ini (kunci akan diabaikan). dapat ditulis
condition[].parameter[].map[] list Parameter parameter peta ini (harus memiliki kunci; kunci harus unik). dapat ditulis
condition[].parameter[].value string Nilai parameter (dapat berisi referensi makro seperti "") yang sesuai dengan jenis yang ditentukan. dapat ditulis
notes string Catatan pengguna tentang cara menerapkan aturan ini di penampung. dapat ditulis

Respons

Jika berhasil, metode ini akan menampilkan resource Aturan dalam isi respons.

Contoh

Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).

Java

Menggunakan library klien Java.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request creates a new rule for the authorized user.
 */

// Construct the condition parameters.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("arg0");
arg0.setValue("{{url}}");

Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("arg1");
arg1.setValue(".*hellowworld.html");

// Construct the condition object
Condition condition = new Condition();
condition.setType("endsWith");
condition.setParameter(Arrays.asList(arg0, arg1));

// Construct the rule object.
Rule rule = new Rule();
rule.setName("Ends With Rule");
rule.setCondition(Arrays.asList(condition));

try {
  Rule response = tagmanager.accounts().
      containers().rules().create("123456", "54321", rule).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the create method are stored in the response object.
 * The following code shows how to access the created Id and Fingerprint.
 */
System.out.println("Rule Id = " + response.getRuleId());
System.out.println("Rule Fingerprint = " + response.getFingerprint());

Python

Menggunakan library klien Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request creates a new rule for the authorized user.
try:
  response = tagmanager.accounts().containers().rules().create(
      accountId='123456',
      containerId='54321',
      body={
          'name': 'Ends with Rule',
          'condition': [
              {
                  'type': 'endsWith',
                  'parameter': [
                      {
                          'type': 'template',
                          'key': 'arg0',
                          'value': '{{url}}'
                      },
                      {
                          'type': 'template',
                          'key': 'arg1',
                          'value': '.*hellowworld.html'
                      }
                  ]
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the create method are stored in the response object.
# The following code shows how to access the created id and fingerprint.
print 'Rule Id = %s' % response.get('ruleId')
print 'Rule Fingerprint = %s' % response.get('fingerprint')

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data live dan melihat respons.