Remarketing Audiences: insert

נדרשת הרשאה

יצירת קהל חדש לרימרקטינג. להצגת דוגמה

בקשה

בקשת HTTP

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences

פרמטרים

שם הפרמטר	ערך	תיאור
פרמטרים של נתיב
accountId	string	מספר החשבון שעבורו יש ליצור את הקהל לרימרקטינג.
webPropertyId	string	מזהה נכס האינטרנט שעבורו יש ליצור את הקהל לרימרקטינג.

אישור

הבקשה הזו מחייבת הרשאה עם ההיקף הבא (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/analytics.edit

גוף הבקשה

בגוף הבקשה, מציינים משאב 'קהלים לרימרקטינג'.

תשובה

אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה משאב של קהלים לרימרקטינג בגוף התגובה.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמש בספריית הלקוח של Java.

/*
 * This request creates a new STATE_BASED Remarketing Audience.
 */
LinkedForeignAccount linkedAdAccount = new LinkedForeignAccount();
linkedAdAccount.setType("ADWORDS_LINKS");
linkedAdAccount.setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
IncludeConditions includeConditions = new IncludeConditions();
includeConditions.setIsSmartList(false);
includeConditions.setMembershipDurationDays(30);
includeConditions.setSegment("users::condition::ga:browser==Chrome");
includeConditions.setDaysToLookBack(30);

// Create the ExcludeConditions object.
ExcludeConditions excludeConditions = new ExcludeConditions();
excludeConditions.setExclusionDuration("PERMANENT");
excludeConditions.setSegment("sessions::condition::ga:city==London");

// Create the AudienceDefinition object.
StateBasedAudienceDefinition stateBasedAudienceDefinition = new StateBasedAudienceDefinition();
stateBasedAudienceDefinition.setIncludeConditions(includeConditions);
stateBasedAudienceDefinition.setExcludeConditions(excludeConditions);

//Create the RemarketingAudience object.
RemarketingAudience audience = new RemarketingAudience();
audience.setName("State Based Audience");
audience.setLinkedViews(Arrays.asList(viewId));
audience.setLinkedAdAccounts(Arrays.asList(linkedAdAccount));
audience.setAudienceType("STATE_BASED");
audience.setStateBasedAudienceDefinition(stateBasedAudienceDefinition);

try {
  analytics
      .management()
      .remarketingAudience()
      .insert(accountId, propertyId, audience)
      .execute();
} catch (GoogleJsonResponseException e) {
  System.err.println(
      "There was a service error: "
          + e.getDetails().getCode()
          + " : "
          + e.getDetails().getMessage());
}


/*
 * This request creates a new SIMPLE Remarketing Audience.
 */

// Create the LinkedForeignAccount object.
LinkedForeignAccount linkedAdAccount = new LinkedForeignAccount();
linkedAdAccount.setType("ADWORDS_LINKS");
linkedAdAccount.setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
IncludeConditions includeConditions = new IncludeConditions();
includeConditions.setIsSmartList(false);
includeConditions.setMembershipDurationDays(30);
includeConditions.setSegment("users::condition::ga:browser==Chrome");
includeConditions.setDaysToLookBack(7);

// Create the AudienceDefinition object.
AudienceDefinition simpleAudienceDefinition = new AudienceDefinition();
simpleAudienceDefinition.setIncludeConditions(includeConditions);

//Create the RemarketingAudience object.
RemarketingAudience audience = new RemarketingAudience();
audience.setName("Simple Audience");
audience.setLinkedViews(Arrays.asList(viewId));
audience.setLinkedAdAccounts(Arrays.asList(linkedAdAccount));
audience.setAudienceType("SIMPLE");
audience.setAudienceDefinition(simpleAudienceDefinition);

try {
  analytics
      .management()
      .remarketingAudience()
      .insert(accountId, propertyId, audience)
      .execute();
} catch (GoogleJsonResponseException e) {
  System.err.println(
      "There was a service error: "
          + e.getDetails().getCode()
          + " : "
          + e.getDetails().getMessage());
}

PHP

משתמש בספריית הלקוח של PHP.

/*
 * This request creates a new STATE_BASED Remarketing Audience.
 */
Google_Service_Analytics_LinkedForeignAccount $linkedAdAccount = new Google_Service_Analytics_LinkedForeignAccount();
$linkedAdAccount->setType("ADWORDS_LINKS");
$linkedAdAccount->setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
Google_Service_Analytics_IncludeConditions $includeConditions = new Google_Service_Analytics_IncludeConditions();
$includeConditions->setIsSmartList(false);
$includeConditions->setMembershipDurationDays(30);
$includeConditions->setSegment("users::condition::ga:browser==Chrome");
$includeConditions->setDaysToLookBack(30);

// Create the ExcludeConditions object.
Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions $excludeConditions = new Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions();
$excludeConditions->setExclusionDuration("PERMANENT");
$excludeConditions->setSegment("sessions::condition::ga:city==London");

// Create the AudienceDefinition object.
Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinition $stateBasedAudienceDefinition = new Google_Service_Analytics_RemarketingAudienceStateBasedAudienceDefinition();
$stateBasedAudienceDefinition->setIncludeConditions($includeConditions);
$stateBasedAudienceDefinition->setExcludeConditions($excludeConditions);

//Create the RemarketingAudience object.
Google_Service_Analytics_RemarketingAudience $audience = new Google_Service_Analytics_RemarketingAudience();
$audience->setName("State Based Audience");
$audience->setLinkedViews(Arrays.asList(viewId));
$audience->setLinkedAdAccounts(Arrays.asList($linkedAdAccount));
$audience->setAudienceType("STATE_BASED");
$audience->setStateBasedAudienceDefinition($stateBasedAudienceDefinition);

try {
  $analytics->management_remarketingAudience->insert($accountId, $propertyId, $audience);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


/*
 * This request creates a new SIMPLE Remarketing Audience.
 */

// Create the LinkedForeignAccount object.
Google_Service_Analytics_LinkedForeignAccount $linkedAdAccount = new Google_Service_Analytics_LinkedForeignAccount();
$linkedAdAccount->setType("ADWORDS_LINKS");
$linkedAdAccount->setLinkedAccountId(linkedAccountId);

// Create the IncludeConditions object.
Google_Service_Analytics_IncludeConditions $includeConditions = new Google_Service_Analytics_IncludeConditions();
$includeConditions->setIsSmartList(false);
$includeConditions->setMembershipDurationDays(30);
$includeConditions->setSegment("users::condition::ga:browser==Chrome");
$includeConditions->setDaysToLookBack(7);

// Create the AudienceDefinition object.
Google_Service_Analytics_RemarketingAudienceAudienceDefinition $simpleAudienceDefinition = new Google_Service_Analytics_RemarketingAudienceAudienceDefinition();
$simpleAudienceDefinition->setIncludeConditions($includeConditions);

//Create the RemarketingAudience object.
Google_Service_Analytics_RemarketingAudience $audience = new Google_Service_Analytics_RemarketingAudience();
$audience->setName("Simple Audience");
$audience->setLinkedViews(Arrays.asList(viewId));
$audience->setLinkedAdAccounts(Arrays.asList($linkedAdAccount));
$audience->setAudienceType("SIMPLE");
$audience->setAudienceDefinition($simpleAudienceDefinition);

try {
  $analytics->management_remarketingAudience->insert($accountId, $propertyId, $audience);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

משתמש בספריית הלקוח של Python.

# Note: This code assumes you have an authorized Analytics service object.
# See the Remarketing Audiences Developer Guide for details.

# This request creates a new STATE_BASED Remarketing Audience.
try:
  response = analytics.management().remarketingAudience().insert(
      accountId=accountId,
      webPropertyId=propertyId,
      body={
        'name': 'State Based Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'STATE_BASED',
        'stateBasedAudienceDefinition': {
          'includeConditions': {
            'daysToLookBack': 30,
            'segment': 'users::condition::ga:browser==Chrome',
            'membershipDurationDays': 30,
            'isSmartList': False
          },
          'excludeConditions': {
            'exclusionDuration': 'PERMANENT',
            'segment': 'sessions::condition::ga:city==London'
          }
        }
      }
    ).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))

# This request creates a new SIMPLE Remarketing Audience.
try:
  response = analytics.management().remarketingAudience().insert(
      accountId=accountId,
      webPropertyId=propertyId,
      body={
        'name': 'Simple Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'SIMPLE',
        'audienceDefinition': {
          'includeConditions': {
            'isSmartList': False,
            'daysToLookBack': 7,
            'membershipDurationDays': 30,
            'segment': 'users::condition::ga:browser==Chrome'
          }
        }
      }
    ).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))

JavaScript

נעשה שימוש בספריית הלקוח של JavaScript.

/**
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Unsampled Reports Developer Guide for details.
 */

/**
 * This request creates a new STATE_BASED Remarketing Audience.
 */
function insertRemarketingAudience(accountId, propertyId) {
  let request = gapi.client.analytics.management.remarketingAudience.insert(
    {
      'accountId': accountId,
      'webPropertyId': propertyId,
      'resource': {
        'name': 'State Based Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'STATE_BASED',
        'stateBasedAudienceDefinition': {
          'includeConditions': {
            'daysToLookBack': 30,
            'segment': 'users::condition::ga:browser==Chrome',
            'membershipDurationDays': 30,
            'isSmartList': False
          },
          'excludeConditions': {
            'exclusionDuration': 'PERMANENT',
            'segment': 'sessions::condition::ga:city==London'
          }
        }
      }
    });
  request.execute(function (response) { /* Handle the response. */ });
}


// This request creates a new SIMPLE Remarketing Audience.
function insertSIMPLEAudience(accountId, propertyId) {
  let request = gapi.client.analytics.management.remarketingAudience.insert(
    {
      'accountId': accountId,
      'webPropertyId': propertyId,
      'resource': {
        'name': 'Simple Audience',
        'linkedViews': [viewId],
        'linkedAdAccounts': [{
            'type': 'ADWORDS_LINKS',
            'linkedAccountId': linkedAccountId
        }],
        'audienceType': 'SIMPLE',
        'audienceDefinition': {
          'includeConditions': {
            'isSmartList': False,
            'daysToLookBack': 7,
            'membershipDurationDays': 30,
            'segment': 'users::condition::ga:browser==Chrome'
          }
        }
      }
    });
  request.execute(function (response) { // Handle the response. });
}