Macros: list

نیاز به مجوز دارد

همه ماکروهای GTM یک کانتینر را فهرست می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .

درخواست

درخواست HTTP

GET https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/macros

مولفه های

نام پارامتر	ارزش	شرح
پارامترهای مسیر
accountId	string	شناسه حساب GTM.
containerId	string	شناسه کانتینر GTM.

مجوز

این درخواست به مجوز حداقل با یکی از حوزه های زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/tagmanager.readonly
https://www.googleapis.com/auth/tagmanager.edit.containers

درخواست بدن

با این روش بدنه درخواستی ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "macros": [
    accounts.containers.macros Resource
  ]
}

نام ملک	ارزش	شرح	یادداشت
macros[]	list	همه ماکروهای GTM یک ظرف GTM.

مثال ها

توجه: نمونه‌های کد موجود برای این روش، همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های مشتری مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

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

/*
 * This requests lists all macros for the authorized user.
 */
try {
  ListMacrosResponse macros = tagmanager.accounts().containers().
      macros().list("123456", "54321").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the list method are stored in the macros object.
 * The following code shows how to iterate through them.
 */
for (Macro macro : macros.getMacros()) {
  System.out.println("Account Id = " + macro.getAccountId());
  System.out.println("Container Id = " + macro.getContainerId());
  System.out.println("Macro Id = " + macro.getMacroId());
  System.out.println("Macro Name = " + macro.getName());
  System.out.println("Macro Type = " + macro.getType());
  System.out.println("Macro Notes = " + macro.getNotes());
  if (macro.getParameter() != null) {
    for (Parameter parameter : macro.getParameter()) {
      System.out.println("Parameter Type = " + parameter.getType());
      System.out.println("Parameter Key = " + parameter.getKey());
      System.out.println("Parameter Value = " + parameter.getValue());
    }
  }
  if (macro.getEnablingRuleId() != null) {
    for (String enabllingRuleId : macro.getEnablingRuleId()) {
      System.out.println("Macro Enabling Rule Id = " + enabllingRuleId);
    }
  }
  if (macro.getDisablingRuleId() != null) {
    for (String disablingRuleId : macro.getDisablingRuleId()) {
      System.out.println("Macro Disabling Rule Id " + disablingRuleId);
    }
  }
  System.out.println("Macro Fingerprint = " + macro.getFingerprint());
}

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

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

# This request lists all macros for the authorized user.
try:
  macros = tagmanager.accounts().containers().macros().list(
      accountId='123456',
      containerId='54321'
  ).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 list method are stored in the macros object.
# The following code shows how to iterate through them.
for macro in macros.get('macros', []):
  print 'Account Id = %s' % macro.get('accountId')
  print 'Container Id = %s' % macro.get('containerId')
  print 'Macro Id = %s' % macro.get('macroId')
  print 'Macro Name = %s' % macro.get('name')
  print 'Macro Type = %s' % macro.get('type')
  print 'Macro notes = %s' % macro.get('notes')
  print 'Schedule Start ms = %s' % macro.get('scheduleStartMs')
  print 'Schedule End ms = %s' % macro.get('scheduleEndMs')
  for parameter in macro.get('parameter', []):
    print 'Parameter Type = %s' % parameter.get('type')
    print 'Parameter Key = %s' % parameter.get('key')
    print 'Parameter Value = %s' % parameter.get('value')
  for enablingRuleId in macro.get('enablingRuleId', []):
    print 'Macro Enabling Rule Id = %s' % enablingRuleId
  for disablingRuleId in macro.get('disablingRuleId', []):
    print 'Macro Disabling Rule Id = %s' % disablingRuleId
  print 'Macro Fingerprint = %s\n\n' % macro.get('fingerprint')

آن را امتحان کنید!

از APIs Explorer زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.