close()

Close httplib2 connections.

create(advertiserId=None, body=None, x__xgafv=None)

Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

Args:
body: object, The request body.
The object takes the form of:

{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
}

advertiserId: string, Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
}

editCustomerMatchMembers(firstAndThirdPartyAudienceId, body=None, x__xgafv=None)

Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

Args:
  firstAndThirdPartyAudienceId: string, Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
  "addedContactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be added.
    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
      "adPersonalization": "A String", # Represents consent for ad personalization.
      "adUserData": "A String", # Represents consent for ad user data.
    },
    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
      { # Contact information defining a Customer Match audience member.
        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
          "A String",
        ],
        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
          "A String",
        ],
        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
          "A String",
        ],
      },
    ],
  },
  "addedMobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be added.
    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
      "adPersonalization": "A String", # Represents consent for ad personalization.
      "adUserData": "A String", # Represents consent for ad user data.
    },
    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
      "A String",
    ],
  },
  "advertiserId": "A String", # Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.
  "removedContactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be removed.
    "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
      "adPersonalization": "A String", # Represents consent for ad personalization.
      "adUserData": "A String", # Represents consent for ad user data.
    },
    "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
      { # Contact information defining a Customer Match audience member.
        "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
        "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
          "A String",
        ],
        "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
        "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
        "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
          "A String",
        ],
        "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
          "A String",
        ],
      },
    ],
  },
  "removedMobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be removed.
    "consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
      "adPersonalization": "A String", # Represents consent for ad personalization.
      "adUserData": "A String", # Represents consent for ad user data.
    },
    "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
      "A String",
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
  "firstAndThirdPartyAudienceId": "A String", # Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.
}

get(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)

Gets a first and third party audience.

Args:
firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audience.
partnerId: string, The ID of the partner that has access to the fetched first and third party audience.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
}

list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)

Lists first and third party audiences. The order is defined by the order_by parameter.

Args:
advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audiences.
filter: string, Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
partnerId: string, The ID of the partner that has access to the fetched first and third party audiences.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"firstAndThirdPartyAudiences": [ # The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.
{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(firstAndThirdPartyAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)

Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`

Args:
firstAndThirdPartyAudienceId: string, Output only. The unique ID of the first and third party audience. Assigned by the system. (required)
body: object, The request body.
The object takes the form of:

{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
}

advertiserId: string, Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
updateMask: string, Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
"activeDisplayAudienceSize": "A String", # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"appId": "A String", # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"audienceSource": "A String", # Output only. The source of the audience.
"audienceType": "A String", # The type of the audience.
"contactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
"consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.
{ # Contact information defining a Customer Match audience member.
"countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
"hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
"A String",
],
"hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
"hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
"hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
"A String",
],
"zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
"A String",
],
},
],
},
"description": "A String", # The user-provided description of the audience. Only applicable to first party audiences.
"displayAudienceSize": "A String", # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
"displayDesktopAudienceSize": "A String", # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileAppAudienceSize": "A String", # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayMobileWebAudienceSize": "A String", # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"displayName": "A String", # The display name of the first and third party audience.
"firstAndThirdPartyAudienceId": "A String", # Output only. The unique ID of the first and third party audience. Assigned by the system.
"firstAndThirdPartyAudienceType": "A String", # Whether the audience is a first or third party audience.
"gmailAudienceSize": "A String", # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
"membershipDurationDays": "A String", # The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
"mobileDeviceIdList": { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
"consent": { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
"adPersonalization": "A String", # Represents consent for ad personalization.
"adUserData": "A String", # Represents consent for ad user data.
},
"mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.
"A String",
],
},
"name": "A String", # Output only. The resource name of the first and third party audience.
"youtubeAudienceSize": "A String", # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
}

Display & Video 360 API . firstAndThirdPartyAudiences

Instance Methods

Method Details