+ close()
Close httplib2 connections.
+
+ get(profileId, summaryAccountId, x__xgafv=None)
Gets the account's active ad summary by account ID.
+close()
+ Close httplib2 connections.+
get(profileId, summaryAccountId, x__xgafv=None)
+ Gets the account's active ad summary by account ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ summaryAccountId: string, Account ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Gets a summary of active ads in an account.
+ "accountId": "A String", # ID of the account.
+ "activeAds": "A String", # Ads that have been activated for the account
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
+ "availableAds": "A String", # Ads that can be activated for the account.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one account permission group by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves the list of account permission groups.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one account permission group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Account permission group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
+ "id": "A String", # ID of this account permission group.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
+ "name": "A String", # Name of this account permission group.
+}
+list(profileId, x__xgafv=None)
+ Retrieves the list of account permission groups.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Account Permission Group List Response
+ "accountPermissionGroups": [ # Account permission group collection.
+ { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
+ "id": "A String", # ID of this account permission group.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
+ "name": "A String", # Name of this account permission group.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one account permission by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves the list of account permissions.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one account permission by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Account permission ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
+ "accountProfiles": [ # Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD"
+ "A String",
+ ],
+ "id": "A String", # ID of this account permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
+ "level": "A String", # Administrative level required to enable this account permission.
+ "name": "A String", # Name of this account permission.
+ "permissionGroupId": "A String", # Permission group of this account permission.
+}
+list(profileId, x__xgafv=None)
+ Retrieves the list of account permissions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Account Permission List Response
+ "accountPermissions": [ # Account permission collection.
+ { # AccountPermissions contains information about a particular account permission. Some features of Campaign Manager require an account permission to be present in the account.
+ "accountProfiles": [ # Account profiles associated with this account permission. Possible values are: - "ACCOUNT_PROFILE_BASIC" - "ACCOUNT_PROFILE_STANDARD"
+ "A String",
+ ],
+ "id": "A String", # ID of this account permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
+ "level": "A String", # Administrative level required to enable this account permission.
+ "name": "A String", # Name of this account permission.
+ "permissionGroupId": "A String", # Permission group of this account permission.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one account user profile by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new account user profile.
+ +Retrieves a list of account user profiles, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing account user profile. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing account user profile.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one account user profile by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, User profile ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new account user profile.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+list(profileId, active=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, userRoleId=None, x__xgafv=None)
+ Retrieves a list of account user profiles, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ active: boolean, Select only active user profiles.
+ ids: string, Select only user profiles with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ subaccountId: string, Select only user profiles with the specified subaccount ID.
+ userRoleId: string, Select only user profiles with the specified user role ID.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Account User Profile List Response
+ "accountUserProfiles": [ # Account user profile collection.
+ { # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing account user profile. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, AccountUserProfile ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing account user profile.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+ "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+ "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "comments": "A String", # Comments for this user profile.
+ "email": "A String", # Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion.
+ "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+ "locale": "A String", # Locale of the user profile. This is a required field. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "name": "A String", # Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "&;<>"#%,".
+ "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+ "traffickerType": "A String", # Trafficker type of this user profile. This is a read-only field.
+ "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+ "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+ "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+ "A String",
+ ],
+ "status": "A String", # Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
+ },
+ "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one account by ID.
+ +Retrieves the list of accounts, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing account. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing account.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one account by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Account ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+}
+list(profileId, active=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves the list of accounts, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.
+ ids: string, Select only accounts with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Account List Response
+ "accounts": [ # Account collection.
+ { # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing account. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Account ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing account.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager account.
+ "accountPermissionIds": [ # Account permissions assigned to this account.
+ "A String",
+ ],
+ "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this account is active.
+ "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+ "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+ "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+ "A String",
+ ],
+ "countryId": "A String", # ID of the country associated with this account.
+ "currencyId": "A String", # ID of currency associated with this account. This is a required field. Acceptable values are: - "1" for USD - "2" for GBP - "3" for ESP - "4" for SEK - "5" for CAD - "6" for JPY - "7" for DEM - "8" for AUD - "9" for FRF - "10" for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - "26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP
+ "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+ "description": "A String", # Description of this account.
+ "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+ "locale": "A String", # Locale of this account. Acceptable values are: - "cs" (Czech) - "de" (German) - "en" (English) - "en-GB" (English United Kingdom) - "es" (Spanish) - "fr" (French) - "it" (Italian) - "ja" (Japanese) - "ko" (Korean) - "pl" (Polish) - "pt-BR" (Portuguese Brazil) - "ru" (Russian) - "sv" (Swedish) - "tr" (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" (Chinese Traditional)
+ "maximumImageSize": "A String", # Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
+ "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+ "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+ "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+ "exposureToConversionEnabled": True or False, # Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "lookbackConfiguration": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are: - "1" for "America/New_York" - "2" for "Europe/London" - "3" for "Europe/Paris" - "4" for "Africa/Johannesburg" - "5" for "Asia/Jerusalem" - "6" for "Asia/Shanghai" - "7" for "Asia/Hong_Kong" - "8" for "Asia/Tokyo" - "9" for "Australia/Sydney" - "10" for "Asia/Dubai" - "11" for "America/Los_Angeles" - "12" for "Pacific/Auckland" - "13" for "America/Sao_Paulo" - "16" for "America/Asuncion" - "17" for "America/Chicago" - "18" for "America/Denver" - "19" for "America/St_Johns" - "20" for "Asia/Dhaka" - "21" for "Asia/Jakarta" - "22" for "Asia/Kabul" - "23" for "Asia/Karachi" - "24" for "Asia/Calcutta" - "25" for "Asia/Pyongyang" - "26" for "Asia/Rangoon" - "27" for "Atlantic/Cape_Verde" - "28" for "Atlantic/South_Georgia" - "29" for "Australia/Adelaide" - "30" for "Australia/Lord_Howe" - "31" for "Europe/Moscow" - "32" for "Pacific/Kiritimati" - "35" for "Pacific/Norfolk" - "36" for "Pacific/Tongatapu"
+ },
+ "shareReportsWithTwitter": True or False, # Share Path to Conversion reports with Twitter.
+ "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one ad by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new ad.
+ +Retrieves a list of ads, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing ad. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing ad.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one ad by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Ad ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new ad.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+list(profileId, active=None, advertiserId=None, archived=None, audienceSegmentIds=None, campaignIds=None, compatibility=None, creativeIds=None, creativeOptimizationConfigurationIds=None, dynamicClickTracker=None, ids=None, landingPageIds=None, maxResults=None, overriddenEventTagId=None, pageToken=None, placementIds=None, remarketingListIds=None, searchString=None, sizeIds=None, sortField=None, sortOrder=None, sslCompliant=None, sslRequired=None, type=None, x__xgafv=None)
+ Retrieves a list of ads, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ active: boolean, Select only active ads.
+ advertiserId: string, Select only ads with this advertiser ID.
+ archived: boolean, Select only archived ads.
+ audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
+ campaignIds: string, Select only ads with these campaign IDs. (repeated)
+ compatibility: string, Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
+ Allowed values
+ DISPLAY -
+ DISPLAY_INTERSTITIAL -
+ APP -
+ APP_INTERSTITIAL -
+ IN_STREAM_VIDEO -
+ IN_STREAM_AUDIO -
+ creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
+ creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
+ dynamicClickTracker: boolean, Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
+ ids: string, Select only ads with these IDs. (repeated)
+ landingPageIds: string, Select only ads with these landing page IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ overriddenEventTagId: string, Select only ads with this event tag override ID.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ placementIds: string, Select only ads with these placement IDs assigned. (repeated)
+ remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
+ sizeIds: string, Select only ads with these size IDs. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ sslCompliant: boolean, Select only ads that are SSL-compliant.
+ sslRequired: boolean, Select only ads that require SSL.
+ type: string, Select only ads with these types. (repeated)
+ Allowed values
+ AD_SERVING_STANDARD_AD -
+ AD_SERVING_DEFAULT_AD -
+ AD_SERVING_CLICK_TRACKER -
+ AD_SERVING_TRACKING -
+ AD_SERVING_BRAND_SAFE_AD -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Ad List Response
+ "ads": [ # Ad collection.
+ { # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing ad. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Ad ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing ad.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager ad.
+ "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+ "active": True or False, # Whether this ad is active. When true, archived must be false.
+ "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this ad is archived. When true, active must be false.
+ "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+ "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix properties for this ad. Applies to the URL in the ad or (if overriding ad properties) the URL in the creative.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comments": "A String", # Comments for this ad.
+ "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+ "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupAssignments": [ # Creative group assignments for this ad. Applicable when type is AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeRotation": { # Creative Rotation. # Creative rotation for this ad. Applicable when type is AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. When type is AD_SERVING_DEFAULT_AD, this field should have exactly one creativeAssignment .
+ "creativeAssignments": [ # Creative assignments in this creative rotation.
+ { # Creative Assignment.
+ "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+ "applyEventTags": True or False, # Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+ { # Companion Click-through override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "creativeId": "A String", # ID of the creative for this companion click-through override.
+ },
+ ],
+ "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+ { # Creative Group Assignment.
+ "creativeGroupId": "A String", # ID of the creative group to be assigned.
+ "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+ },
+ ],
+ "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+ "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "endTime": "A String",
+ "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR
+ { # Rich Media Exit Override.
+ "clickThroughUrl": { # Click-through URL # Click-through URL of this rich media exit override. Applicable if the enabled field is set to true.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field. - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field. - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+ "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+ },
+ "enabled": True or False, # Whether to use the clickThroughUrl. If false, the creative-level exit will be used.
+ "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+ },
+ ],
+ "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, inclusive.
+ "sslCompliant": True or False, # Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1.
+ },
+ ],
+ "creativeOptimizationConfigurationId": "A String", # Creative optimization configuration that is used by this ad. It should refer to one of the existing optimization configurations in the ad's campaign. If it is unset or set to 0, then the campaign's default optimization configuration will be used for this ad.
+ "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+ "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Default click-through event tag properties for this ad.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "deliverySchedule": { # Delivery Schedule. # Delivery schedule information for this ad. Applicable when type is AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with subfields priority and impressionRatio are required on insertion when type is AD_SERVING_STANDARD_AD.
+ "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+ "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days. Acceptable values are 1 to 7776000, inclusive.
+ "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. Acceptable values are 1 to 15, inclusive.
+ },
+ "hardCutoff": True or False, # Whether or not hard cutoff is enabled. If true, the ad will not serve after the end date and time. Otherwise the ad will continue to be served until it has reached its delivery goals.
+ "impressionRatio": "A String", # Impression ratio for this ad. This ratio determines how often each ad is served relative to the others. For example, if ad A has an impression ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager will serve ad B three times as often as ad A. Acceptable values are 1 to 10, inclusive.
+ "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+ },
+ "dynamicClickTracker": True or False, # Whether this ad is a dynamic click tracker. Applicable when type is AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only after insert.
+ "endTime": "A String",
+ "eventTagOverrides": [ # Event tag overrides for this ad.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+ "languageTargeting": { # Language Targeting. # Language targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+ "placementAssignments": [ # Placement assignments for this ad.
+ { # Placement Assignment.
+ "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+ "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+ "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "sslRequired": True or False, # Whether the placement to be assigned requires SSL. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ },
+ ],
+ "remarketingListExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting expression for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+ "startTime": "A String",
+ "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+ "targetingTemplateId": "A String", # Targeting template ID, used to apply preconfigured targeting information to this ad. This cannot be set while any of dayPartTargeting, geoTargeting, keyValueTargetingExpression, languageTargeting, remarketingListExpression, or technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. This field must be left blank if the ad is using a targeting template. Applicable when type is AD_SERVING_STANDARD_AD.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ "type": "A String", # Type of ad. This is a required field on insertion. Note that default ads ( AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource).
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing advertiser group.
+
+ get(profileId, id, x__xgafv=None)
Gets one advertiser group by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new advertiser group.
+ +Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing advertiser group. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing advertiser group.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing advertiser group. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Advertiser group ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one advertiser group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Advertiser group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new advertiser group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Select only advertiser groups with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Advertiser Group List Response
+ "advertiserGroups": [ # Advertiser group collection.
+ { # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing advertiser group. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, AdvertiserGroup ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing advertiser group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Groups advertisers together so that reports can be generated for the entire group at once.
+ "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+ "name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one landing page by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new landing page.
+ +Retrieves a list of landing pages.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing advertiser landing page. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing landing page.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one landing page by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Landing page ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new landing page.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+list(profileId, advertiserIds=None, archived=None, campaignIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)
+ Retrieves a list of landing pages.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only landing pages that belong to these advertisers. (repeated)
+ archived: boolean, Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
+ campaignIds: string, Select only landing pages that are associated with these campaigns. (repeated)
+ ids: string, Select only landing pages with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ subaccountId: string, Select only landing pages that belong to this subaccount.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Landing Page List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserLandingPagesListResponse".
+ "landingPages": [ # Landing page collection
+ { # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+ },
+ ],
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing advertiser landing page. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, LandingPage ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing landing page.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about where a user's browser is taken after the user clicks an ad.
+ "advertiserId": "A String", # Advertiser ID of this landing page. This is a required field.
+ "archived": True or False, # Whether this landing page has been archived.
+ "deepLinks": [ # Links that will direct the user to a mobile app, if installed.
+ { # Contains information about a landing page deep link.
+ "appUrl": "A String", # The URL of the mobile app being linked to.
+ "fallbackUrl": "A String", # The fallback URL. This URL will be served to users who do not have the mobile app installed.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#deepLink".
+ "mobileApp": { # Contains information about a mobile app. Used as a landing page deep link. # The mobile app targeted by this deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ "remarketingListIds": [ # Ads served to users on these remarketing lists will use this deep link. Applicable when mobileApp.directory is APPLE_APP_STORE.
+ "A String",
+ ],
+ },
+ ],
+ "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+ "name": "A String", # Name of this landing page. This is a required field. It must be less than 256 characters long.
+ "url": "A String", # URL of this landing page. This is a required field.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one advertiser by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new advertiser.
+ +Retrieves a list of advertisers, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing advertiser. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing advertiser.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one advertiser by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Advertiser ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new advertiser.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+list(profileId, advertiserGroupIds=None, floodlightConfigurationIds=None, ids=None, includeAdvertisersWithoutGroupsOnly=None, maxResults=None, onlyParent=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, status=None, subaccountId=None, x__xgafv=None)
+ Retrieves a list of advertisers, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
+ floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
+ ids: string, Select only advertisers with these IDs. (repeated)
+ includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
+ maxResults: integer, Maximum number of results to return.
+ onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ status: string, Select only advertisers with the specified status.
+ Allowed values
+ APPROVED -
+ ON_HOLD -
+ subaccountId: string, Select only advertisers with these subaccount IDs.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Advertiser List Response
+ "advertisers": [ # Advertiser collection.
+ { # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing advertiser. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Advertiser ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing advertiser.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager advertiser.
+ "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+ "advertiserGroupId": "A String", # ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
+ "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+ "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as: - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups. - This advertiser's original floodlight configuration is not already shared with another advertiser.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+ "measurementPartnerLink": { # Measurement partner advertiser link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerAdvertiserId": "A String", # .
+ },
+ "name": "A String", # Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
+ "originalFloodlightConfigurationId": "A String", # Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
+ "status": "A String", # Status of this advertiser.
+ "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+ "suspended": True or False, # Suspension status of this advertiser.
+}
+
+ close()
Close httplib2 connections.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of browsers.
+close()
+ Close httplib2 connections.+
list(profileId, x__xgafv=None)
+ Retrieves a list of browsers.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Browser List Response
+ "browsers": [ # Browser collection.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ insert(profileId, campaignId, body=None, x__xgafv=None)
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
+
+ list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None, x__xgafv=None)
Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
insert(profileId, campaignId, body=None, x__xgafv=None)
+ Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ campaignId: string, Campaign ID in this association. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Identifies a creative which has been associated with a given campaign.
+ "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Identifies a creative which has been associated with a given campaign.
+ "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+}
+list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None, x__xgafv=None)
+ Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ campaignId: string, Campaign ID in this association. (required)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Campaign Creative Association List Response
+ "campaignCreativeAssociations": [ # Campaign creative association collection
+ { # Identifies a creative which has been associated with a given campaign.
+ "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one campaign by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new campaign.
+ +Retrieves a list of campaigns, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing campaign. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing campaign.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one campaign by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Campaign ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new campaign.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+list(profileId, advertiserGroupIds=None, advertiserIds=None, archived=None, atLeastOneOptimizationActivity=None, excludedIds=None, ids=None, maxResults=None, overriddenEventTagId=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)
+ Retrieves a list of campaigns, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
+ advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
+ archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
+ atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.
+ excludedIds: string, Exclude campaigns with these IDs. (repeated)
+ ids: string, Select only campaigns with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ subaccountId: string, Select only campaigns that belong to this subaccount.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Campaign List Response
+ "campaigns": [ # Campaign collection.
+ { # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing campaign. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Campaign ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing campaign.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager campaign.
+ "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+ "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
+ "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.
+ },
+ "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+ { # Creative optimization settings.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ ],
+ "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+ "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this campaign has been archived.
+ "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+ { # Audience Segment Group.
+ "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+ { # Audience Segment.
+ "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive.
+ "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+ },
+ ],
+ "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
+ "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+ "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+ "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+ },
+ "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+ "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+ "A String",
+ ],
+ "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+ "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.
+ "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+ "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+ { # Creative optimization activity.
+ "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+ "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1.
+ },
+ ],
+ "optimizationModel": "A String", # Optimization model for this configuration.
+ },
+ "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign.
+ "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+ "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+ },
+ "defaultLandingPageId": "A String", # The default landing page ID for this campaign.
+ "endDate": "A String",
+ "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+ { # Event tag override information.
+ "enabled": True or False, # Whether this override is enabled.
+ "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+ },
+ ],
+ "externalId": "A String", # External ID for this campaign.
+ "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "measurementPartnerLink": { # Measurement partner campaign link for tag wrapping.
+ "linkStatus": "A String", # .
+ "measurementPartner": "A String", # Measurement partner used for tag wrapping.
+ "partnerCampaignId": "A String", # Partner campaign ID needed for establishing linking with Measurement partner.
+ },
+ "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.
+ "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+ "traffickerEmails": [ # Campaign trafficker contact emails.
+ "A String",
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one change log by ID.
+ +Retrieves a list of change logs. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one change log by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Change log ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes a change that a user has made to a resource.
+ "accountId": "A String", # Account ID of the modified object.
+ "action": "A String", # Action which caused the change.
+ "changeTime": "A String",
+ "fieldName": "A String", # Field name of the object which changed.
+ "id": "A String", # ID of this change log.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
+ "newValue": "A String", # New value of the object field.
+ "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
+ "objectType": "A String", # Object type of the change log.
+ "oldValue": "A String", # Old value of the object field.
+ "subaccountId": "A String", # Subaccount ID of the modified object.
+ "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
+ "userProfileId": "A String", # ID of the user who modified the object.
+ "userProfileName": "A String", # User profile name of the user who modified the object.
+}
+list(profileId, action=None, ids=None, maxChangeTime=None, maxResults=None, minChangeTime=None, objectIds=None, objectType=None, pageToken=None, searchString=None, userProfileIds=None, x__xgafv=None)
+ Retrieves a list of change logs. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ action: string, Select only change logs with the specified action.
+ Allowed values
+ ACTION_CREATE -
+ ACTION_UPDATE -
+ ACTION_DELETE -
+ ACTION_ENABLE -
+ ACTION_DISABLE -
+ ACTION_ADD -
+ ACTION_REMOVE -
+ ACTION_MARK_AS_DEFAULT -
+ ACTION_ASSOCIATE -
+ ACTION_ASSIGN -
+ ACTION_UNASSIGN -
+ ACTION_SEND -
+ ACTION_LINK -
+ ACTION_UNLINK -
+ ACTION_PUSH -
+ ACTION_EMAIL_TAGS -
+ ACTION_SHARE -
+ ids: string, Select only change logs with these IDs. (repeated)
+ maxChangeTime: string, Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
+ maxResults: integer, Maximum number of results to return.
+ minChangeTime: string, Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
+ objectIds: string, Select only change logs with these object IDs. (repeated)
+ objectType: string, Select only change logs with the specified object type.
+ Allowed values
+ OBJECT_ADVERTISER -
+ OBJECT_FLOODLIGHT_CONFIGURATION -
+ OBJECT_AD -
+ OBJECT_FLOODLIGHT_ACTVITY -
+ OBJECT_CAMPAIGN -
+ OBJECT_FLOODLIGHT_ACTIVITY_GROUP -
+ OBJECT_CREATIVE -
+ OBJECT_PLACEMENT -
+ OBJECT_DFA_SITE -
+ OBJECT_USER_ROLE -
+ OBJECT_USER_PROFILE -
+ OBJECT_ADVERTISER_GROUP -
+ OBJECT_ACCOUNT -
+ OBJECT_SUBACCOUNT -
+ OBJECT_RICHMEDIA_CREATIVE -
+ OBJECT_INSTREAM_CREATIVE -
+ OBJECT_MEDIA_ORDER -
+ OBJECT_CONTENT_CATEGORY -
+ OBJECT_PLACEMENT_STRATEGY -
+ OBJECT_SD_SITE -
+ OBJECT_SIZE -
+ OBJECT_CREATIVE_GROUP -
+ OBJECT_CREATIVE_ASSET -
+ OBJECT_USER_PROFILE_FILTER -
+ OBJECT_LANDING_PAGE -
+ OBJECT_CREATIVE_FIELD -
+ OBJECT_REMARKETING_LIST -
+ OBJECT_PROVIDED_LIST_CLIENT -
+ OBJECT_EVENT_TAG -
+ OBJECT_CREATIVE_BUNDLE -
+ OBJECT_BILLING_ACCOUNT_GROUP -
+ OBJECT_BILLING_FEATURE -
+ OBJECT_RATE_CARD -
+ OBJECT_ACCOUNT_BILLING_FEATURE -
+ OBJECT_BILLING_MINIMUM_FEE -
+ OBJECT_BILLING_PROFILE -
+ OBJECT_PLAYSTORE_LINK -
+ OBJECT_TARGETING_TEMPLATE -
+ OBJECT_SEARCH_LIFT_STUDY -
+ OBJECT_FLOODLIGHT_DV360_LINK -
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
+ userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Change Log List Response
+ "changeLogs": [ # Change log collection.
+ { # Describes a change that a user has made to a resource.
+ "accountId": "A String", # Account ID of the modified object.
+ "action": "A String", # Action which caused the change.
+ "changeTime": "A String",
+ "fieldName": "A String", # Field name of the object which changed.
+ "id": "A String", # ID of this change log.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
+ "newValue": "A String", # New value of the object field.
+ "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
+ "objectType": "A String", # Object type of the change log.
+ "oldValue": "A String", # Old value of the object field.
+ "subaccountId": "A String", # Subaccount ID of the modified object.
+ "transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId.
+ "userProfileId": "A String", # ID of the user who modified the object.
+ "userProfileName": "A String", # User profile name of the user who modified the object.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+ +Retrieves a list of cities, possibly filtered.
+close()
+ Close httplib2 connections.+
list(profileId, countryDartIds=None, dartIds=None, namePrefix=None, regionDartIds=None, x__xgafv=None)
+ Retrieves a list of cities, possibly filtered.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ countryDartIds: string, Select only cities from these countries. (repeated)
+ dartIds: string, Select only cities with these DART IDs. (repeated)
+ namePrefix: string, Select only cities with names starting with this prefix.
+ regionDartIds: string, Select only cities from these regions. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # City List Response
+ "cities": [ # City collection.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one connection type by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of connection types.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one connection type by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Connection type ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of connection types.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Connection Type List Response
+ "connectionTypes": [ # Collection of connection types such as broadband and mobile.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing content category.
+
+ get(profileId, id, x__xgafv=None)
Gets one content category by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new content category.
+ +Retrieves a list of content categories, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing content category. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing content category.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing content category. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Content category ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one content category by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Content category ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new content category.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of content categories, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Select only content categories with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Content Category List Response
+ "contentCategories": [ # Content category collection.
+ { # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing content category. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, ContentCategory ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing content category.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Organizes placements according to the contents of their associated webpages.
+ "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+ "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+ "name": "A String", # Name of this content category. This is a required field and must be less than 256 characters long and unique among content categories of the same account.
+}
+
+ batchinsert(profileId, body=None, x__xgafv=None)
Inserts conversions.
+
+ batchupdate(profileId, body=None, x__xgafv=None)
Updates existing conversions.
+
+ close()
Close httplib2 connections.
+batchinsert(profileId, body=None, x__xgafv=None)
+ Inserts conversions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Insert Conversions Request.
+ "conversions": [ # The set of conversions to insert.
+ { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
+ "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
+ },
+ ],
+ "dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "A String",
+ ],
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
+ "matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
+ "nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "quantity": "A String", # The quantity of the conversion.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
+ "value": 3.14, # The value of the conversion.
+ },
+ ],
+ "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.
+ "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
+ "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
+ "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Insert Conversions Response.
+ "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
+ "status": [ # The insert status of each conversion. Statuses are returned in the same order that conversions are inserted.
+ { # The original conversion that was inserted or updated and whether there were any errors.
+ "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
+ "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
+ },
+ ],
+ "dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "A String",
+ ],
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
+ "matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
+ "nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "quantity": "A String", # The quantity of the conversion.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
+ "value": 3.14, # The value of the conversion.
+ },
+ "errors": [ # A list of errors related to this conversion.
+ { # The error code and description for a conversion that failed to insert or update.
+ "code": "A String", # The error code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
+ "message": "A String", # A description of the error.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
+ },
+ ],
+}
+batchupdate(profileId, body=None, x__xgafv=None)
+ Updates existing conversions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Update Conversions Request.
+ "conversions": [ # The set of conversions to update.
+ { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
+ "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
+ },
+ ],
+ "dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "A String",
+ ],
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
+ "matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
+ "nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "quantity": "A String", # The quantity of the conversion.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
+ "value": 3.14, # The value of the conversion.
+ },
+ ],
+ "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
+ "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
+ "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
+ "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Update Conversions Response.
+ "hasFailures": True or False, # Indicates that some or all conversions failed to update.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
+ "status": [ # The update status of each conversion. Statuses are returned in the same order that conversions are updated.
+ { # The original conversion that was inserted or updated and whether there were any errors.
+ "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
+ "childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
+ "customVariables": [ # Custom floodlight variables.
+ { # A custom floodlight variable.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
+ "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
+ "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 100 characters.
+ },
+ ],
+ "dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
+ "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
+ "A String",
+ ],
+ "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
+ "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
+ "gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
+ "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
+ "matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
+ "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
+ "nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized ad.
+ "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
+ "quantity": "A String", # The quantity of the conversion.
+ "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
+ "treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
+ "value": 3.14, # The value of the conversion.
+ },
+ "errors": [ # A list of errors related to this conversion.
+ { # The error code and description for a conversion that failed to insert or update.
+ "code": "A String", # The error code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
+ "message": "A String", # A description of the error.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
+ },
+ ],
+}
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ get(profileId, dartId, x__xgafv=None)
Gets one country by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of countries.
+close()
+ Close httplib2 connections.+
get(profileId, dartId, x__xgafv=None)
+ Gets one country by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ dartId: string, Country DART ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of countries.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Country List Response
+ "countries": [ # Country collection.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
Inserts a new creative asset.
+close()
+ Close httplib2 connections.+
insert(profileId, advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
+ Inserts a new creative asset.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
+ "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "clickTags": [ # List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "counterCustomEvents": [ # List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "exitCustomEvents": [ # List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
+ "richMedia": True or False, # True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.
+ "timerCustomEvents": [ # List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID"
+ "A String",
+ ],
+}
+
+ media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+ media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # CreativeAssets contains properties of a creative asset file which will be uploaded or has already been uploaded. Refer to the creative sample code for how to upload assets and insert a creative.
+ "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "clickTags": [ # List of detected click tags for assets. This is a read-only, auto-generated field. This field is empty for a rich media asset.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "counterCustomEvents": [ # List of counter events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "exitCustomEvents": [ # List of exit events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "id": "A String", # Numeric ID of the asset. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the numeric ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
+ "richMedia": True or False, # True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.
+ "timerCustomEvents": [ # List of timer events configured for the asset. This is a read-only, auto-generated field and only applicable to a rich media asset.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field. Possible values are: - "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - "CLICK_TAG_NON_TOP_LEVEL" - "COMPONENT_UNSUPPORTED_DCM" - "ENABLER_UNSUPPORTED_METHOD_DCM" - "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - "PRIMARY_HTML_MISSING" - "SVG_INVALID" - "ZIP_INVALID"
+ "A String",
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, creativeFieldId, id, x__xgafv=None)
Deletes an existing creative field value.
+
+ get(profileId, creativeFieldId, id, x__xgafv=None)
Gets one creative field value by ID.
+
+ insert(profileId, creativeFieldId, body=None, x__xgafv=None)
Inserts a new creative field value.
+ +Retrieves a list of creative field values, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, creativeFieldId, id, body=None, x__xgafv=None)
Updates an existing creative field value. This method supports patch semantics.
+
+ update(profileId, creativeFieldId, body=None, x__xgafv=None)
Updates an existing creative field value.
+close()
+ Close httplib2 connections.+
delete(profileId, creativeFieldId, id, x__xgafv=None)
+ Deletes an existing creative field value. + +Args: + profileId: string, User profile ID associated with this request. (required) + creativeFieldId: string, Creative field ID for this creative field value. (required) + id: string, Creative Field Value ID (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, creativeFieldId, id, x__xgafv=None)
+ Gets one creative field value by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ creativeFieldId: string, Creative field ID for this creative field value. (required)
+ id: string, Creative Field Value ID (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+insert(profileId, creativeFieldId, body=None, x__xgafv=None)
+ Inserts a new creative field value.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ creativeFieldId: string, Creative field ID for this creative field value. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+list(profileId, creativeFieldId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of creative field values, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ creativeFieldId: string, Creative field ID for this creative field value. (required)
+ ids: string, Select only creative field values with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ VALUE -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Creative Field Value List Response
+ "creativeFieldValues": [ # Creative field value collection.
+ { # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, creativeFieldId, id, body=None, x__xgafv=None)
+ Updates an existing creative field value. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ creativeFieldId: string, CreativeField ID. (required)
+ id: string, CreativeFieldValue ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+update(profileId, creativeFieldId, body=None, x__xgafv=None)
+ Updates an existing creative field value.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ creativeFieldId: string, Creative field ID for this creative field value. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field value.
+ "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+ "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing creative field.
+
+ get(profileId, id, x__xgafv=None)
Gets one creative field by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new creative field.
+ +Retrieves a list of creative fields, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing creative field. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing creative field.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing creative field. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Creative Field ID (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one creative field by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Creative Field ID (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new creative field.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of creative fields, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
+ ids: string, Select only creative fields with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Creative Field List Response
+ "creativeFields": [ # Creative field collection.
+ { # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing creative field. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, CreativeField ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing creative field.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative field.
+ "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+ "name": "A String", # Name of this creative field. This is a required field and must be less than 256 characters long and unique among creative fields of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one creative group by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new creative group.
+ +Retrieves a list of creative groups, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing creative group. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing creative group.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one creative group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Creative group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new creative group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+list(profileId, advertiserIds=None, groupNumber=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of creative groups, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
+ groupNumber: integer, Select only creative groups that belong to this subgroup.
+ ids: string, Select only creative groups with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Creative Group List Response
+ "creativeGroups": [ # Creative group collection.
+ { # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing creative group. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, CreativeGroup ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing creative group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a creative group.
+ "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "groupNumber": 42, # Subgroup of the creative group. Assign your creative groups to a subgroup in order to filter or manage them more easily. This field is required on insertion and is read-only after insertion. Acceptable values are 1 to 2, inclusive.
+ "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+ "name": "A String", # Name of this creative group. This is a required field and must be less than 256 characters long and unique among creative groups of the same advertiser.
+ "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one creative by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new creative.
+ +Retrieves a list of creatives, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing creative. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing creative.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one creative by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Creative ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new creative.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+list(profileId, active=None, advertiserId=None, archived=None, campaignId=None, companionCreativeIds=None, creativeFieldIds=None, ids=None, maxResults=None, pageToken=None, renderingIds=None, searchString=None, sizeIds=None, sortField=None, sortOrder=None, studioCreativeId=None, types=None, x__xgafv=None)
+ Retrieves a list of creatives, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
+ advertiserId: string, Select only creatives with this advertiser ID.
+ archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
+ campaignId: string, Select only creatives with this campaign ID.
+ companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
+ creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)
+ ids: string, Select only creatives with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ renderingIds: string, Select only creatives with these rendering IDs. (repeated)
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
+ sizeIds: string, Select only creatives with these size IDs. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
+ types: string, Select only creatives with these creative types. (repeated)
+ Allowed values
+ IMAGE -
+ DISPLAY_REDIRECT -
+ CUSTOM_DISPLAY -
+ INTERNAL_REDIRECT -
+ CUSTOM_DISPLAY_INTERSTITIAL -
+ INTERSTITIAL_INTERNAL_REDIRECT -
+ TRACKING_TEXT -
+ RICH_MEDIA_DISPLAY_BANNER -
+ RICH_MEDIA_INPAGE_FLOATING -
+ RICH_MEDIA_IM_EXPAND -
+ RICH_MEDIA_DISPLAY_EXPANDING -
+ RICH_MEDIA_DISPLAY_INTERSTITIAL -
+ RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL -
+ RICH_MEDIA_MOBILE_IN_APP -
+ FLASH_INPAGE -
+ INSTREAM_VIDEO -
+ VPAID_LINEAR_VIDEO -
+ VPAID_NON_LINEAR_VIDEO -
+ INSTREAM_VIDEO_REDIRECT -
+ RICH_MEDIA_PEEL_DOWN -
+ HTML5_BANNER -
+ DISPLAY -
+ DISPLAY_IMAGE_GALLERY -
+ BRAND_SAFE_DEFAULT_INSTREAM_VIDEO -
+ INSTREAM_AUDIO -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Creative List Response
+ "creatives": [ # Creative collection.
+ { # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing creative. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Creative ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing creative.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Creative.
+ "accountId": "A String", # Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "active": True or False, # Whether the creative is active. Applicable to all creative types.
+ "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "adTagKeys": [ # Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "additionalSizes": [ # Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+ "allowScriptAccess": True or False, # Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE.
+ "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+ "artworkType": "A String", # Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+ "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "autoAdvanceImages": True or False, # Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY.
+ "backgroundColor": "A String", # The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE.
+ "backupImageClickThroughUrl": { # Click-through URL # Click-through URL for backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "backupImageFeatures": [ # List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE.
+ "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "customHtml": "A String", # User-entered value.
+ "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+ },
+ "clickTags": [ # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Click Tag.
+ "clickThroughUrl": { # Click-through URL # Parameter value for the specified click tag. This field contains a click-through url.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "name": "A String", # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field.
+ },
+ ],
+ "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives.
+ "companionCreatives": [ # List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false.
+ "A String",
+ ],
+ "compatibility": [ # Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL"
+ "A String",
+ ],
+ "convertFlashToHtml5": True or False, # Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "counterCustomEvents": [ # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "creativeAssetSelection": { # Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. # Required if dynamicAssetSelection is true.
+ "defaultAssetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative, and will be served if none of the rules match. This is a required field.
+ "rules": [ # Rules determine which asset will be served to a viewer. Rules will be evaluated in the order in which they are stored in this list. This list must contain at least one rule. Applicable to INSTREAM_VIDEO creatives.
+ { # A rule associates an asset with a targeting template for asset-level targeting. Applicable to INSTREAM_VIDEO creatives.
+ "assetId": "A String", # A creativeAssets[].id. This should refer to one of the parent assets in this creative. This is a required field.
+ "name": "A String", # A user-friendly name for this rule. This is a required field.
+ "targetingTemplateId": "A String", # A targeting template ID. The targeting from the targeting template will be used to determine whether this asset should be served. This is a required field.
+ },
+ ],
+ },
+ "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+ { # Creative Asset.
+ "actionScript3": True or False, # Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "active": True or False, # Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "additionalSizes": [ # Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
+ "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "assetIdentifier": { # Creative Asset ID. # Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "name": "A String", # Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed.
+ "type": "A String", # Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE.
+ },
+ "audioBitRate": 42, # Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "audioSampleRate": 42, # Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ "bitRate": 42, # Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+ "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "companionCreativeIds": [ # List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
+ "A String",
+ ],
+ "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
+ "detectedFeatures": [ # List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "A String",
+ ],
+ "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
+ "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+ "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "fileSize": "A String", # File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "flashVersion": 42, # Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "frameRate": 3.14, # Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "id": "A String", # Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the asset. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "mediaDuration": 3.14, # Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "mimeType": "A String", # Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
+ "offset": { # Offset Position. # Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "orientation": "A String", # Orientation of video asset. This is a read-only, auto-generated field.
+ "originalBackup": True or False, # Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
+ "politeLoad": True or False, # Whether this asset is used as a polite load asset.
+ "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "positionTopUnit": "A String", # Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
+ "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "pushdown": True or False, # Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
+ "pushdownDuration": 3.14, # Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
+ "role": "A String", # Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslCompliant": True or False, # Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
+ "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+ "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+ "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+ "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+ "windowMode": "A String", # Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
+ "zIndex": 42, # zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
+ "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+ },
+ ],
+ "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+ { # Creative Field Assignment.
+ "creativeFieldId": "A String", # ID of the creative field.
+ "creativeFieldValueId": "A String", # ID of the creative field value.
+ },
+ ],
+ "customKeyValues": [ # Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "A String",
+ ],
+ "dynamicAssetSelection": True or False, # Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives.
+ "exitCustomEvents": [ # List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "fsCommand": { # FsCommand. # OpenWindow FSCommand of this creative. This lets the SWF file communicate with either Flash Player or the program hosting Flash Player, such as a web browser. This is only triggered if allowScriptAccess field is true. Applicable to the following creative types: FLASH_INPAGE.
+ "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "positionOption": "A String", # Position in the browser where the window will open.
+ "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+ "windowHeight": 42, # Height of the window.
+ "windowWidth": 42, # Width of the window.
+ },
+ "htmlCode": "A String", # HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
+ "htmlCodeLocked": True or False, # Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER.
+ "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+ "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "latestTraffickedCreativeId": "A String", # Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "mediaDescription": "A String", # Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID.
+ "mediaDuration": 3.14, # Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID.
+ "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+ "obaIcon": { # Online Behavioral Advertiser icon. # Online behavioral advertising icon to be added to the creative. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+ "progressOffset": { # Video Offset # Amount of time to play the video before counting a view. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "redirectUrl": "A String", # URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT
+ "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+ "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "requiredFlashPluginVersion": "A String", # The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "requiredFlashVersion": 42, # The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. This is a required field when applicable; however for IMAGE, FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset of type HTML_IMAGE, if left blank, this field will be automatically set using the actual size of the associated image assets. Applicable to the following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play the video before the skip button appears. Applicable to the following creative types: all INSTREAM_VIDEO.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+ "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+ "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+ "studioAdvertiserId": "A String", # Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioCreativeId": "A String", # Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "studioTraffickedCreativeId": "A String", # Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "subaccountId": "A String", # Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types.
+ "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA.
+ "thirdPartyUrls": [ # Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID.
+ { # Third-party Tracking URL.
+ "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video and in-stream audio creatives.
+ "url": "A String", # URL for the specified third-party URL type.
+ },
+ ],
+ "timerCustomEvents": [ # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE.
+ { # Creative Custom Event.
+ "advertiserCustomEventId": "A String", # Unique ID of this event used by Reporting and Data Transfer. This is a read-only field.
+ "advertiserCustomEventName": "A String", # User-entered name for the event.
+ "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+ "artworkLabel": "A String", # Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion.
+ "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+ "exitClickThroughUrl": { # Click-through URL # Exit click-through URL for the event. This field is used only for exit events.
+ "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field.
+ "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the landingPageId field is left unset.
+ "landingPageId": "A String", # ID of the landing page for the click-through URL.
+ },
+ "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+ "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+ "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+ "left": 42, # Offset distance from left side of an asset or a window.
+ "top": 42, # Offset distance from top side of an asset or a window.
+ },
+ "positionType": "A String", # Popup window position either centered or at specific coordinate.
+ "showAddressBar": True or False, # Whether to display the browser address bar.
+ "showMenuBar": True or False, # Whether to display the browser menu bar.
+ "showScrollBar": True or False, # Whether to display the browser scroll bar.
+ "showStatusBar": True or False, # Whether to display the browser status bar.
+ "showToolBar": True or False, # Whether to display the browser tool bar.
+ "title": "A String", # Title of popup window.
+ },
+ "targetType": "A String", # Target type used by the event.
+ "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+ },
+ ],
+ "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+ "type": "A String", # Type of this creative. This is a required field. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types.
+ "universalAdId": { # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID.
+ "registry": "A String", # Registry used for the Ad ID value.
+ "value": "A String", # ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM.
+ },
+ "version": 42, # The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types.
+}
+
+ close()
Close httplib2 connections.
+
+ query(profileId, body=None, maxResults=None, pageToken=None, x__xgafv=None)
Retrieves list of report dimension values for a list of filters.
+
+ query_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
query(profileId, body=None, maxResults=None, pageToken=None, x__xgafv=None)
+ Retrieves list of report dimension values for a list of filters.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a DimensionValuesRequest.
+ "dimensionName": "A String", # The name of the dimension for which values should be requested.
+ "endDate": "A String",
+ "filters": [ # The list of filters by which to filter values. The filters are ANDed.
+ { # Represents a dimension filter.
+ "dimensionName": "A String", # The name of the dimension to filter.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionFilter.
+ "value": "A String", # The value of the dimension to filter.
+ },
+ ],
+ "kind": "A String", # The kind of request this is, in this case dfareporting#dimensionValueRequest .
+ "startDate": "A String",
+}
+
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, The value of the nextToken from the previous result page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the list of DimensionValue resources.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "items": [ # The dimension values returned in this response.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of list this is, in this case dfareporting#dimensionValueList.
+ "nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
+}
+query_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one directory site by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new directory site.
+ +Retrieves a list of directory sites, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one directory site by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Directory site ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
+ "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
+ "A String",
+ ],
+ "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
+ "A String",
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+ "name": "A String", # Name of this directory site.
+ "settings": { # Directory Site Settings # Directory site settings.
+ "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+ "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
+ "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
+ "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
+ "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+ "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+ "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
+ },
+ "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
+ "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+ },
+ "url": "A String", # URL of this directory site.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new directory site.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
+ "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
+ "A String",
+ ],
+ "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
+ "A String",
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+ "name": "A String", # Name of this directory site.
+ "settings": { # Directory Site Settings # Directory site settings.
+ "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+ "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
+ "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
+ "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
+ "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+ "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+ "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
+ },
+ "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
+ "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+ },
+ "url": "A String", # URL of this directory site.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
+ "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
+ "A String",
+ ],
+ "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
+ "A String",
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+ "name": "A String", # Name of this directory site.
+ "settings": { # Directory Site Settings # Directory site settings.
+ "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+ "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
+ "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
+ "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
+ "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+ "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+ "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
+ },
+ "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
+ "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+ },
+ "url": "A String", # URL of this directory site.
+}
+list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, active=None, dfpNetworkCode=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of directory sites, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+ acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+ acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
+ active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
+ dfpNetworkCode: string, Select only directory sites with this Ad Manager network code.
+ ids: string, Select only directory sites with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Directory Site List Response
+ "directorySites": [ # Directory site collection.
+ { # DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement.
+ "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inpageTagFormats": [ # Tag types for regular placements. Acceptable values are: - "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE"
+ "A String",
+ ],
+ "interstitialTagFormats": [ # Tag types for interstitial placements. Acceptable values are: - "IFRAME_JAVASCRIPT_INTERSTITIAL" - "INTERNAL_REDIRECT_INTERSTITIAL" - "JAVASCRIPT_INTERSTITIAL"
+ "A String",
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+ "name": "A String", # Name of this directory site.
+ "settings": { # Directory Site Settings # Directory site settings.
+ "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+ "dfpSettings": { # Google Ad Manager Settings # Directory site Ad Manager settings.
+ "dfpNetworkCode": "A String", # Ad Manager network code for this directory site.
+ "dfpNetworkName": "A String", # Ad Manager network name for this directory site.
+ "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+ "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+ "publisherPortalOnly": True or False, # Whether this directory site is available only via Publisher Portal.
+ },
+ "instreamVideoPlacementAccepted": True or False, # Whether this site accepts in-stream video ads.
+ "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+ },
+ "url": "A String", # URL of this directory site.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ delete(profileId, objectId, name, objectType, x__xgafv=None)
Deletes an existing dynamic targeting key.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
+
+ list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)
Retrieves a list of dynamic targeting keys.
+close()
+ Close httplib2 connections.+
delete(profileId, objectId, name, objectType, x__xgafv=None)
+ Deletes an existing dynamic targeting key. + +Args: + profileId: string, User profile ID associated with this request. (required) + objectId: string, ID of the object of this dynamic targeting key. This is a required field. (required) + name: string, Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. (required) + objectType: string, Type of the object of this dynamic targeting key. This is a required field. (required) + Allowed values + OBJECT_ADVERTISER - + OBJECT_AD - + OBJECT_CREATIVE - + OBJECT_PLACEMENT - + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
insert(profileId, body=None, x__xgafv=None)
+ Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+}
+list(profileId, advertiserId=None, names=None, objectId=None, objectType=None, x__xgafv=None)
+ Retrieves a list of dynamic targeting keys.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only dynamic targeting keys whose object has this advertiser ID.
+ names: string, Select only dynamic targeting keys exactly matching these names. (repeated)
+ objectId: string, Select only dynamic targeting keys with this object ID.
+ objectType: string, Select only dynamic targeting keys with this object type.
+ Allowed values
+ OBJECT_ADVERTISER -
+ OBJECT_AD -
+ OBJECT_CREATIVE -
+ OBJECT_PLACEMENT -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Dynamic Targeting Key List Response
+ "dynamicTargetingKeys": [ # Dynamic targeting key collection.
+ { # Contains properties of a dynamic targeting key. Dynamic targeting keys are unique, user-friendly labels, created at the advertiser level in DCM, that can be assigned to ads, creatives, and placements and used for targeting with Studio dynamic creatives. Use these labels instead of numeric Campaign Manager IDs (such as placement IDs) to save time and avoid errors in your dynamic feeds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey".
+ "name": "A String", # Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
+ "objectId": "A String", # ID of the object of this dynamic targeting key. This is a required field.
+ "objectType": "A String", # Type of the object of this dynamic targeting key. This is a required field.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKeysListResponse".
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing event tag.
+
+ get(profileId, id, x__xgafv=None)
Gets one event tag by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new event tag.
+ +Retrieves a list of event tags, possibly filtered.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing event tag. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing event tag.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing event tag. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Event tag ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one event tag by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Event tag ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new event tag.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+list(profileId, adId=None, advertiserId=None, campaignId=None, definitionsOnly=None, enabled=None, eventTagTypes=None, ids=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of event tags, possibly filtered.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ adId: string, Select only event tags that belong to this ad.
+ advertiserId: string, Select only event tags that belong to this advertiser.
+ campaignId: string, Select only event tags that belong to this campaign.
+ definitionsOnly: boolean, Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
+ enabled: boolean, Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
+ eventTagTypes: string, Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. (repeated)
+ Allowed values
+ IMPRESSION_IMAGE_EVENT_TAG -
+ IMPRESSION_JAVASCRIPT_EVENT_TAG -
+ CLICK_THROUGH_EVENT_TAG -
+ ids: string, Select only event tags with these IDs. (repeated)
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Event Tag List Response
+ "eventTags": [ # Event tag collection.
+ { # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
+}
+patch(profileId, id, body=None, x__xgafv=None)
+ Updates an existing event tag. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, EventTag ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing event tag.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of an event tag.
+ "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+ "excludeFromAdxRequests": True or False, # Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.
+ "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+ "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+ "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+ "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.
+ "A String",
+ ],
+ "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+ "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+ "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+ "type": "A String", # Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field.
+ "url": "A String", # Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion.
+ "urlEscapeLevels": 42, # Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type.
+}
+
+ close()
Close httplib2 connections.
+
+ get(reportId, fileId, x__xgafv=None)
Retrieves a report file by its report ID and file ID. This method supports media download.
+
+ get_media(reportId, fileId, x__xgafv=None)
Retrieves a report file by its report ID and file ID. This method supports media download.
+ +Lists files for a user profile.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(reportId, fileId, x__xgafv=None)
+ Retrieves a report file by its report ID and file ID. This method supports media download.
+
+Args:
+ reportId: string, The ID of the report. (required)
+ fileId: string, The ID of the report file. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "etag": "A String", # Etag of this resource.
+ "fileName": "A String", # The filename of the file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "id": "A String", # The unique ID of this report file.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "status": "A String", # The status of the report file.
+ "urls": { # The URLs where the completed report file can be downloaded.
+ "apiUrl": "A String", # The URL for downloading the report data through the API.
+ "browserUrl": "A String", # The URL for downloading the report data through a browser.
+ },
+}
+get_media(reportId, fileId, x__xgafv=None)
+ Retrieves a report file by its report ID and file ID. This method supports media download. + +Args: + reportId: string, The ID of the report. (required) + fileId: string, The ID of the report file. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + The media object as a string. + ++
list(profileId, maxResults=None, pageToken=None, scope=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Lists files for a user profile.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, The value of the nextToken from the previous result page.
+ scope: string, The scope that defines which results are returned.
+ Allowed values
+ ALL - All files in account.
+ MINE - My files.
+ SHARED_WITH_ME - Files shared with me.
+ sortField: string, The field by which to sort the list.
+ Allowed values
+ ID - Sort by file ID.
+ LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List of files for a report.
+ "etag": "A String", # Etag of this resource.
+ "items": [ # The files returned in this response.
+ { # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "etag": "A String", # Etag of this resource.
+ "fileName": "A String", # The filename of the file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "id": "A String", # The unique ID of this report file.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "status": "A String", # The status of the report file.
+ "urls": { # The URLs where the completed report file can be downloaded.
+ "apiUrl": "A String", # The URL for downloading the report data through the API.
+ "browserUrl": "A String", # The URL for downloading the report data through a browser.
+ },
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#fileList".
+ "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing floodlight activity.
+
+ generatetag(profileId, floodlightActivityId=None, x__xgafv=None)
Generates a tag for a floodlight activity.
+
+ get(profileId, id, x__xgafv=None)
Gets one floodlight activity by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new floodlight activity.
+ +Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing floodlight activity. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing floodlight activity.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing floodlight activity. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Floodlight activity ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
generatetag(profileId, floodlightActivityId=None, x__xgafv=None)
+ Generates a tag for a floodlight activity.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Floodlight Activity GenerateTag Response
+ "floodlightActivityTag": "A String", # Generated tag for this Floodlight activity. For global site tags, this is the event snippet.
+ "globalSiteTagGlobalSnippet": "A String", # The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
+}
+get(profileId, id, x__xgafv=None)
+ Gets one floodlight activity by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Floodlight activity ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new floodlight activity.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+list(profileId, advertiserId=None, floodlightActivityGroupIds=None, floodlightActivityGroupName=None, floodlightActivityGroupTagString=None, floodlightActivityGroupType=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, tagString=None, x__xgafv=None)
+ Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
+ floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
+ floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
+ floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
+ floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
+ Allowed values
+ COUNTER -
+ SALE -
+ floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
+ ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ tagString: string, Select only floodlight activities with the specified tag string.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Floodlight Activity List Response
+ "floodlightActivities": [ # Floodlight activity collection.
+ { # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing floodlight activity. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, FloodlightActivity ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing floodlight activity.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity.
+ "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "attributionEnabled": True or False, # Whether the activity is enabled for attribution.
+ "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING.
+ "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+ "defaultTags": [ # Dynamic floodlight tags.
+ { # Dynamic Tag
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ ],
+ "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+ "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+ "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+ "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field.
+ "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+ "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+ "notes": "A String", # General notes or implementation instructions for the tag.
+ "publisherTags": [ # Publisher dynamic floodlight tags.
+ { # Publisher Dynamic Tag
+ "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+ "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated.
+ "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+ "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+ "name": "A String", # Name of this tag.
+ "tag": "A String", # Tag code.
+ },
+ "siteId": "A String", # Site ID of this dynamic tag.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+ },
+ ],
+ "secure": True or False, # Whether this tag should use SSL.
+ "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+ "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+ "status": "A String", # The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+ "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+ "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.
+ "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive.
+ "A String",
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one floodlight activity group by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new floodlight activity group.
+ +Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing floodlight activity group. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing floodlight activity group.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one floodlight activity group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Floodlight activity Group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new floodlight activity group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+list(profileId, advertiserId=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)
+ Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
+ floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
+ ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ type: string, Select only floodlight activity groups with the specified floodlight activity group type.
+ Allowed values
+ COUNTER -
+ SALE -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Floodlight Activity Group List Response
+ "floodlightActivityGroups": [ # Floodlight activity group collection.
+ { # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing floodlight activity group. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, FloodlightActivityGroup ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing floodlight activity group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight activity group.
+ "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+ "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+ "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+ "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+ "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion.
+ "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one floodlight configuration by ID.
+
+ list(profileId, ids=None, x__xgafv=None)
Retrieves a list of floodlight configurations, possibly filtered.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing floodlight configuration. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing floodlight configuration.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one floodlight configuration by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Floodlight configuration ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+}
+list(profileId, ids=None, x__xgafv=None)
+ Retrieves a list of floodlight configurations, possibly filtered.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Floodlight Configuration List Response
+ "floodlightConfigurations": [ # Floodlight configuration collection.
+ { # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
+}
+patch(profileId, id, body=None, x__xgafv=None)
+ Updates an existing floodlight configuration. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, FloodlightConfiguration ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing floodlight configuration.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Floodlight configuration.
+ "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+ "customViewabilityMetric": { # Custom Viewability Metric # Custom Viewability metric for the floodlight configuration.
+ "configuration": { # The attributes, like playtime and percent onscreen, that define the Custom Viewability Metric. # Configuration of the custom viewability metric.
+ "audible": True or False, # Whether the video must be audible to count an impression.
+ "timeMillis": 42, # The time in milliseconds the video must play for the Custom Viewability Metric to count an impression. If both this and timePercent are specified, the earlier of the two will be used.
+ "timePercent": 42, # The percentage of video that must play for the Custom Viewability Metric to count an impression. If both this and timeMillis are specified, the earlier of the two will be used.
+ "viewabilityPercent": 42, # The percentage of video that must be on screen for the Custom Viewability Metric to count an impression.
+ },
+ "id": "A String", # ID of the custom viewability metric.
+ "name": "A String", # Name of the custom viewability metric.
+ },
+ "exposureToConversionEnabled": True or False, # Whether the exposure-to-conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting.
+ "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+ "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+ "omnitureSettings": { # Omniture Integration Settings. # Settings for Campaign Manager Omniture integration.
+ "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+ "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+ },
+ "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+ "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+ "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+ "imageTagEnabled": True or False, # Whether image tags are enabled.
+ },
+ "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+ { # Third Party Authentication Token
+ "name": "A String", # Name of the third-party authentication token.
+ "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+ },
+ ],
+ "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+ { # User Defined Variable configuration.
+ "dataType": "A String", # Data type for the variable. This is a required field.
+ "reportName": "A String", # User-friendly name for the variable which will appear in reports. This is a required field, must be less than 64 characters long, and cannot contain the following characters: ""<>".
+ "variableType": "A String", # Variable name in the tag. This is a required field.
+ },
+ ],
+}
+
+ accountActiveAdSummaries()
+
Returns the accountActiveAdSummaries Resource.
+ + +Returns the accountPermissionGroups Resource.
+ + +Returns the accountPermissions Resource.
+ + +Returns the accountUserProfiles Resource.
+ +
+ accounts()
+
Returns the accounts Resource.
+ +
+ ads()
+
Returns the ads Resource.
+ + +Returns the advertiserGroups Resource.
+ + +Returns the advertiserLandingPages Resource.
+ +
+ advertisers()
+
Returns the advertisers Resource.
+ +
+ browsers()
+
Returns the browsers Resource.
+ +
+ campaignCreativeAssociations()
+
Returns the campaignCreativeAssociations Resource.
+ +
+ campaigns()
+
Returns the campaigns Resource.
+ +
+ changeLogs()
+
Returns the changeLogs Resource.
+ +
+ cities()
+
Returns the cities Resource.
+ + +Returns the connectionTypes Resource.
+ + +Returns the contentCategories Resource.
+ +
+ conversions()
+
Returns the conversions Resource.
+ +
+ countries()
+
Returns the countries Resource.
+ +
+ creativeAssets()
+
Returns the creativeAssets Resource.
+ + +Returns the creativeFieldValues Resource.
+ +
+ creativeFields()
+
Returns the creativeFields Resource.
+ +
+ creativeGroups()
+
Returns the creativeGroups Resource.
+ +
+ creatives()
+
Returns the creatives Resource.
+ + +Returns the dimensionValues Resource.
+ +
+ directorySites()
+
Returns the directorySites Resource.
+ + +Returns the dynamicTargetingKeys Resource.
+ +
+ eventTags()
+
Returns the eventTags Resource.
+ +
+ files()
+
Returns the files Resource.
+ + +Returns the floodlightActivities Resource.
+ +
+ floodlightActivityGroups()
+
Returns the floodlightActivityGroups Resource.
+ +
+ floodlightConfigurations()
+
Returns the floodlightConfigurations Resource.
+ +
+ inventoryItems()
+
Returns the inventoryItems Resource.
+ +
+ languages()
+
Returns the languages Resource.
+ +
+ metros()
+
Returns the metros Resource.
+ +
+ mobileApps()
+
Returns the mobileApps Resource.
+ +
+ mobileCarriers()
+
Returns the mobileCarriers Resource.
+ + +Returns the operatingSystemVersions Resource.
+ + +Returns the operatingSystems Resource.
+ +
+ orderDocuments()
+
Returns the orderDocuments Resource.
+ +
+ orders()
+
Returns the orders Resource.
+ + +Returns the placementGroups Resource.
+ + +Returns the placementStrategies Resource.
+ +
+ placements()
+
Returns the placements Resource.
+ +
+ platformTypes()
+
Returns the platformTypes Resource.
+ +
+ postalCodes()
+
Returns the postalCodes Resource.
+ +
+ projects()
+
Returns the projects Resource.
+ +
+ regions()
+
Returns the regions Resource.
+ + +Returns the remarketingListShares Resource.
+ + +Returns the remarketingLists Resource.
+ +
+ reports()
+
Returns the reports Resource.
+ +
+ sites()
+
Returns the sites Resource.
+ +
+ sizes()
+
Returns the sizes Resource.
+ +
+ subaccounts()
+
Returns the subaccounts Resource.
+ +
+ targetableRemarketingLists()
+
Returns the targetableRemarketingLists Resource.
+ + +Returns the targetingTemplates Resource.
+ +
+ userProfiles()
+
Returns the userProfiles Resource.
+ +
+ userRolePermissionGroups()
+
Returns the userRolePermissionGroups Resource.
+ + +Returns the userRolePermissions Resource.
+ +
+ userRoles()
+
Returns the userRoles Resource.
+ +
+ videoFormats()
+
Returns the videoFormats Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, projectId, id, x__xgafv=None)
Gets one inventory item by ID.
+ +Retrieves a list of inventory items, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, projectId, id, x__xgafv=None)
+ Gets one inventory item by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for order documents. (required)
+ id: string, Inventory item ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a buy from the Planning inventory store.
+ "accountId": "A String", # Account ID of this inventory item.
+ "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
+ { # Ad Slot
+ "comment": "A String", # Comment for this ad slot.
+ "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
+ "height": "A String", # Height of this ad slot.
+ "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
+ "name": "A String", # Name of this ad slot.
+ "paymentSourceType": "A String", # Payment source type of this ad slot.
+ "primary": True or False, # Primary ad slot of a roadblock inventory item.
+ "width": "A String", # Width of this ad slot.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this inventory item.
+ "contentCategoryId": "A String", # Content category ID of this inventory item.
+ "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
+ "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
+ "id": "A String", # ID of this inventory item.
+ "inPlan": True or False, # Whether this inventory item is in plan.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
+ "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
+ "orderId": "A String", # Order ID of this inventory item.
+ "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
+ "pricing": { # Pricing Information # Pricing of this inventory item.
+ "capCostType": "A String", # Cap cost type of this inventory item.
+ "endDate": "A String",
+ "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
+ { # Flight
+ "endDate": "A String",
+ "rateOrCost": "A String", # Rate or cost of this flight.
+ "startDate": "A String",
+ "units": "A String", # Units of this flight.
+ },
+ ],
+ "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
+ "pricingType": "A String", # Pricing type of this inventory item.
+ "startDate": "A String",
+ },
+ "projectId": "A String", # Project ID of this inventory item.
+ "rfpId": "A String", # RFP ID of this inventory item.
+ "siteId": "A String", # ID of the site this inventory item is associated with.
+ "subaccountId": "A String", # Subaccount ID of this inventory item.
+ "type": "A String", # Type of inventory item.
+}
+list(profileId, projectId, ids=None, inPlan=None, maxResults=None, orderId=None, pageToken=None, siteId=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)
+ Retrieves a list of inventory items, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for order documents. (required)
+ ids: string, Select only inventory items with these IDs. (repeated)
+ inPlan: boolean, Select only inventory items that are in plan.
+ maxResults: integer, Maximum number of results to return.
+ orderId: string, Select only inventory items that belong to specified orders. (repeated)
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ siteId: string, Select only inventory items that are associated with these sites. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ type: string, Select only inventory items with this type.
+ Allowed values
+ PLANNING_PLACEMENT_TYPE_REGULAR -
+ PLANNING_PLACEMENT_TYPE_CREDIT -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Inventory item List Response
+ "inventoryItems": [ # Inventory item collection
+ { # Represents a buy from the Planning inventory store.
+ "accountId": "A String", # Account ID of this inventory item.
+ "adSlots": [ # Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.
+ { # Ad Slot
+ "comment": "A String", # Comment for this ad slot.
+ "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
+ "height": "A String", # Height of this ad slot.
+ "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
+ "name": "A String", # Name of this ad slot.
+ "paymentSourceType": "A String", # Payment source type of this ad slot.
+ "primary": True or False, # Primary ad slot of a roadblock inventory item.
+ "width": "A String", # Width of this ad slot.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this inventory item.
+ "contentCategoryId": "A String", # Content category ID of this inventory item.
+ "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
+ "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
+ "id": "A String", # ID of this inventory item.
+ "inPlan": True or False, # Whether this inventory item is in plan.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.
+ "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
+ "orderId": "A String", # Order ID of this inventory item.
+ "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
+ "pricing": { # Pricing Information # Pricing of this inventory item.
+ "capCostType": "A String", # Cap cost type of this inventory item.
+ "endDate": "A String",
+ "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
+ { # Flight
+ "endDate": "A String",
+ "rateOrCost": "A String", # Rate or cost of this flight.
+ "startDate": "A String",
+ "units": "A String", # Units of this flight.
+ },
+ ],
+ "groupType": "A String", # Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary.
+ "pricingType": "A String", # Pricing type of this inventory item.
+ "startDate": "A String",
+ },
+ "projectId": "A String", # Project ID of this inventory item.
+ "rfpId": "A String", # RFP ID of this inventory item.
+ "siteId": "A String", # ID of the site this inventory item is associated with.
+ "subaccountId": "A String", # Subaccount ID of this inventory item.
+ "type": "A String", # Type of inventory item.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of languages.
+close()
+ Close httplib2 connections.+
list(profileId, x__xgafv=None)
+ Retrieves a list of languages.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Language List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#languagesListResponse".
+ "languages": [ # Language collection.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of metros.
+close()
+ Close httplib2 connections.+
list(profileId, x__xgafv=None)
+ Retrieves a list of metros.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Metro List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
+ "metros": [ # Metro collection.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one mobile app by ID.
+ +Retrieves list of available mobile apps.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one mobile app by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Mobile app ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a mobile app. Used as a landing page deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+}
+list(profileId, directories=None, ids=None, maxResults=None, pageToken=None, searchString=None, x__xgafv=None)
+ Retrieves list of available mobile apps.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ directories: string, Select only apps from these directories. (repeated)
+ Allowed values
+ UNKNOWN -
+ APPLE_APP_STORE -
+ GOOGLE_PLAY_STORE -
+ ids: string, Select only apps with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Mobile app List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse".
+ "mobileApps": [ # Mobile apps collection.
+ { # Contains information about a mobile app. Used as a landing page deep link.
+ "directory": "A String", # Mobile app directory.
+ "id": "A String", # ID of this mobile app.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp".
+ "publisherName": "A String", # Publisher name.
+ "title": "A String", # Title of this mobile app.
+ },
+ ],
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one mobile carrier by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of mobile carriers.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one mobile carrier by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Mobile carrier ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of mobile carriers.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Mobile Carrier List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
+ "mobileCarriers": [ # Mobile carrier collection.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one operating system version by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of operating system versions.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one operating system version by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Operating system version ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of operating system versions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Operating System Version List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
+ "operatingSystemVersions": [ # Operating system version collection.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, dartId, x__xgafv=None)
Gets one operating system by DART ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of operating systems.
+close()
+ Close httplib2 connections.+
get(profileId, dartId, x__xgafv=None)
+ Gets one operating system by DART ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ dartId: string, Operating system DART ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of operating systems.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Operating System List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
+ "operatingSystems": [ # Operating system collection.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, projectId, id, x__xgafv=None)
Gets one order document by ID.
+ +Retrieves a list of order documents, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, projectId, id, x__xgafv=None)
+ Gets one order document by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for order documents. (required)
+ id: string, Order document ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Planning order document.
+ "accountId": "A String", # Account ID of this order document.
+ "advertiserId": "A String", # Advertiser ID of this order document.
+ "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
+ "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
+ "A String",
+ ],
+ "cancelled": True or False, # Whether this order document is cancelled.
+ "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "effectiveDate": "A String",
+ "id": "A String", # ID of this order document.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
+ "lastSentRecipients": [ # List of email addresses that received the last sent document.
+ "A String",
+ ],
+ "lastSentTime": "A String",
+ "orderId": "A String", # ID of the order from which this order document is created.
+ "projectId": "A String", # Project ID of this order document.
+ "signed": True or False, # Whether this order document has been signed.
+ "subaccountId": "A String", # Subaccount ID of this order document.
+ "title": "A String", # Title of this order document.
+ "type": "A String", # Type of this order document
+}
+list(profileId, projectId, approved=None, ids=None, maxResults=None, orderId=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of order documents, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for order documents. (required)
+ approved: boolean, Select only order documents that have been approved by at least one user.
+ ids: string, Select only order documents with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ orderId: string, Select only order documents for specified orders. (repeated)
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
+ siteId: string, Select only order documents that are associated with these sites. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Order document List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "orderDocuments": [ # Order document collection
+ { # Contains properties of a Planning order document.
+ "accountId": "A String", # Account ID of this order document.
+ "advertiserId": "A String", # Advertiser ID of this order document.
+ "amendedOrderDocumentId": "A String", # The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.
+ "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
+ "A String",
+ ],
+ "cancelled": True or False, # Whether this order document is cancelled.
+ "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "effectiveDate": "A String",
+ "id": "A String", # ID of this order document.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
+ "lastSentRecipients": [ # List of email addresses that received the last sent document.
+ "A String",
+ ],
+ "lastSentTime": "A String",
+ "orderId": "A String", # ID of the order from which this order document is created.
+ "projectId": "A String", # Project ID of this order document.
+ "signed": True or False, # Whether this order document has been signed.
+ "subaccountId": "A String", # Subaccount ID of this order document.
+ "title": "A String", # Title of this order document.
+ "type": "A String", # Type of this order document
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, projectId, id, x__xgafv=None)
Gets one order by ID.
+ +Retrieves a list of orders, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, projectId, id, x__xgafv=None)
+ Gets one order by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for orders. (required)
+ id: string, Order ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes properties of a Planning order.
+ "accountId": "A String", # Account ID of this order.
+ "advertiserId": "A String", # Advertiser ID of this order.
+ "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
+ "A String",
+ ],
+ "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
+ "buyerOrganizationName": "A String", # Name of the buyer organization.
+ "comments": "A String", # Comments in this order.
+ "contacts": [ # Contacts for this order.
+ { # Contact of an order.
+ "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
+ "contactName": "A String", # Name of this contact.
+ "contactTitle": "A String", # Title of this contact.
+ "contactType": "A String", # Type of this contact.
+ "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
+ },
+ ],
+ "id": "A String", # ID of this order. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this order.
+ "notes": "A String", # Notes of this order.
+ "planningTermId": "A String", # ID of the terms and conditions template used in this order.
+ "projectId": "A String", # Project ID of this order.
+ "sellerOrderId": "A String", # Seller order ID associated with this order.
+ "sellerOrganizationName": "A String", # Name of the seller organization.
+ "siteId": [ # Site IDs this order is associated with.
+ "A String",
+ ],
+ "siteNames": [ # Free-form site names this order is associated with.
+ "A String",
+ ],
+ "subaccountId": "A String", # Subaccount ID of this order.
+ "termsAndConditions": "A String", # Terms and conditions of this order.
+}
+list(profileId, projectId, ids=None, maxResults=None, pageToken=None, searchString=None, siteId=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of orders, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ projectId: string, Project ID for orders. (required)
+ ids: string, Select only orders with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
+ siteId: string, Select only orders that are associated with these site IDs. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Order List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "orders": [ # Order collection.
+ { # Describes properties of a Planning order.
+ "accountId": "A String", # Account ID of this order.
+ "advertiserId": "A String", # Advertiser ID of this order.
+ "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
+ "A String",
+ ],
+ "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
+ "buyerOrganizationName": "A String", # Name of the buyer organization.
+ "comments": "A String", # Comments in this order.
+ "contacts": [ # Contacts for this order.
+ { # Contact of an order.
+ "contactInfo": "A String", # Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.
+ "contactName": "A String", # Name of this contact.
+ "contactTitle": "A String", # Title of this contact.
+ "contactType": "A String", # Type of this contact.
+ "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
+ },
+ ],
+ "id": "A String", # ID of this order. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this order.
+ "notes": "A String", # Notes of this order.
+ "planningTermId": "A String", # ID of the terms and conditions template used in this order.
+ "projectId": "A String", # Project ID of this order.
+ "sellerOrderId": "A String", # Seller order ID associated with this order.
+ "sellerOrganizationName": "A String", # Name of the seller organization.
+ "siteId": [ # Site IDs this order is associated with.
+ "A String",
+ ],
+ "siteNames": [ # Free-form site names this order is associated with.
+ "A String",
+ ],
+ "subaccountId": "A String", # Subaccount ID of this order.
+ "termsAndConditions": "A String", # Terms and conditions of this order.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one placement group by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new placement group.
+ +Retrieves a list of placement groups, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing placement group. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing placement group.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one placement group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Placement group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new placement group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+list(profileId, advertiserIds=None, archived=None, campaignIds=None, contentCategoryIds=None, directorySiteIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, placementGroupType=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of placement groups, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
+ archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
+ campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
+ contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
+ directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
+ ids: string, Select only placement groups with these IDs. (repeated)
+ maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
+ maxResults: integer, Maximum number of results to return.
+ maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
+ minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
+ minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
+ Allowed values
+ PLACEMENT_PACKAGE -
+ PLACEMENT_ROADBLOCK -
+ placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
+ pricingTypes: string, Select only placement groups with these pricing types. (repeated)
+ Allowed values
+ PRICING_TYPE_CPM -
+ PRICING_TYPE_CPC -
+ PRICING_TYPE_CPA -
+ PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
+ PRICING_TYPE_FLAT_RATE_CLICKS -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
+ searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
+ siteIds: string, Select only placement groups that are associated with these sites. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Placement Group List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "placementGroups": [ # Placement group collection.
+ { # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing placement group. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, PlacementGroup ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing placement group.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a package or roadblock.
+ "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+ "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement group is archived.
+ "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+ "A String",
+ ],
+ "comment": "A String", # Comments for this placement group.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+ "placementGroupType": "A String", # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primaryPlacementId": "A String", # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
+ "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "siteId": "A String", # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing placement strategy.
+
+ get(profileId, id, x__xgafv=None)
Gets one placement strategy by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new placement strategy.
+ +Retrieves a list of placement strategies, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing placement strategy. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing placement strategy.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing placement strategy. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, Placement strategy ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one placement strategy by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Placement strategy ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new placement strategy.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of placement strategies, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Select only placement strategies with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Placement Strategy List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "placementStrategies": [ # Placement strategy collection.
+ { # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing placement strategy. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, PlacementStrategy ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing placement strategy.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement strategy.
+ "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+ "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+ "name": "A String", # Name of this placement strategy. This is a required field. It must be less than 256 characters long and unique among placement strategies of the same account.
+}
+
+ close()
Close httplib2 connections.
+
+ generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)
Generates tags for a placement.
+
+ get(profileId, id, x__xgafv=None)
Gets one placement by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new placement.
+ +Retrieves a list of placements, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing placement. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing placement.
+close()
+ Close httplib2 connections.+
generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)
+ Generates tags for a placement.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ campaignId: string, Generate placements belonging to this campaign. This is a required field.
+ placementIds: string, Generate tags for these placements. (repeated)
+ tagFormats: string, Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. (repeated)
+ Allowed values
+ PLACEMENT_TAG_STANDARD -
+ PLACEMENT_TAG_IFRAME_JAVASCRIPT -
+ PLACEMENT_TAG_IFRAME_ILAYER -
+ PLACEMENT_TAG_INTERNAL_REDIRECT -
+ PLACEMENT_TAG_JAVASCRIPT -
+ PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT -
+ PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT -
+ PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT -
+ PLACEMENT_TAG_CLICK_COMMANDS -
+ PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH -
+ PLACEMENT_TAG_TRACKING -
+ PLACEMENT_TAG_TRACKING_IFRAME -
+ PLACEMENT_TAG_TRACKING_JAVASCRIPT -
+ PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 -
+ PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY -
+ PLACEMENT_TAG_JAVASCRIPT_LEGACY -
+ PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY -
+ PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY -
+ PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4 -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Placement GenerateTags Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
+ "placementTags": [ # Set of generated tags for the specified placements.
+ { # Placement Tag
+ "placementId": "A String", # Placement ID
+ "tagDatas": [ # Tags generated for this placement.
+ { # Placement Tag Data
+ "adId": "A String", # Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
+ "clickTag": "A String", # Tag string to record a click.
+ "creativeId": "A String", # Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
+ "format": "A String", # TagData tag format of this tag.
+ "impressionTag": "A String", # Tag string for serving an ad.
+ },
+ ],
+ },
+ ],
+}
+get(profileId, id, x__xgafv=None)
+ Gets one placement by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Placement ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new placement.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+list(profileId, advertiserIds=None, archived=None, campaignIds=None, compatibilities=None, contentCategoryIds=None, directorySiteIds=None, groupIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, paymentSource=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sizeIds=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of placements, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
+ archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
+ campaignIds: string, Select only placements that belong to these campaigns. (repeated)
+ compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
+ Allowed values
+ DISPLAY -
+ DISPLAY_INTERSTITIAL -
+ APP -
+ APP_INTERSTITIAL -
+ IN_STREAM_VIDEO -
+ IN_STREAM_AUDIO -
+ contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
+ directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
+ groupIds: string, Select only placements that belong to these placement groups. (repeated)
+ ids: string, Select only placements with these IDs. (repeated)
+ maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
+ maxResults: integer, Maximum number of results to return.
+ maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
+ minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
+ minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ paymentSource: string, Select only placements with this payment source.
+ Allowed values
+ PLACEMENT_AGENCY_PAID -
+ PLACEMENT_PUBLISHER_PAID -
+ placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
+ pricingTypes: string, Select only placements with these pricing types. (repeated)
+ Allowed values
+ PRICING_TYPE_CPM -
+ PRICING_TYPE_CPC -
+ PRICING_TYPE_CPA -
+ PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
+ PRICING_TYPE_FLAT_RATE_CLICKS -
+ PRICING_TYPE_CPM_ACTIVEVIEW -
+ searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" .
+ siteIds: string, Select only placements that are associated with these sites. (repeated)
+ sizeIds: string, Select only placements that are associated with these sizes. (repeated)
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Placement List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "placements": [ # Placement collection.
+ { # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing placement. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Placement ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing placement.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a placement.
+ "accountId": "A String", # Account ID of this placement. This field can be left blank.
+ "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
+ "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "archived": True or False, # Whether this placement is archived.
+ "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+ "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "comment": "A String", # Comments for this placement.
+ "compatibility": "A String", # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
+ "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+ "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "directorySiteId": "A String", # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "externalId": "A String", # External ID for this placement.
+ "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+ "clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ "postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
+ },
+ "name": "A String", # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
+ "partnerWrappingData": { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
+ "linkStatus": "A String", # Placement wrapping status.
+ "measurementPartner": "A String", # Measurement partner used for wrapping the placement.
+ "tagWrappingMode": "A String", # Measurement mode for the wrapped placement.
+ "wrappedTag": "A String", # Tag provided by the measurement partner during wrapping.
+ },
+ "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+ "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+ "placementGroupId": "A String", # ID of this placement's group, if applicable.
+ "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+ "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+ "capCostOption": "A String", # Placement cap cost option.
+ "endDate": "A String",
+ "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+ "pricingPeriods": [ # Pricing periods for this placement.
+ { # Pricing Period
+ "endDate": "A String",
+ "pricingComment": "A String", # Comments for this pricing period.
+ "rateOrCostNanos": "A String", # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
+ "startDate": "A String",
+ "units": "A String", # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
+ },
+ ],
+ "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+ "startDate": "A String",
+ "testingStartDate": "A String",
+ },
+ "primary": True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.
+ "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "siteId": "A String", # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
+ "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+ "status": "A String", # Third-party placement status.
+ "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+ "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME" - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+ "A String",
+ ],
+ "tagSetting": { # Tag Settings # Tag settings for this placement.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOut": True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
+ "videoSettings": { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
+ "companionsDisabled": True or False, # Whether companions are disabled for this placement.
+ "enabledSizes": [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting".
+ },
+ "durationSeconds": 42, # Duration of a video placement in seconds.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this placement.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting".
+ },
+ },
+ "vpaidAdapterChoice": "A String", # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ "wrappingOptOut": True or False, # Whether this placement opts out of tag wrapping.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one platform type by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of platform types.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one platform type by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Platform type ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of platform types.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Platform Type List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
+ "platformTypes": [ # Platform type collection.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, code, x__xgafv=None)
Gets one postal code by ID.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of postal codes.
+close()
+ Close httplib2 connections.+
get(profileId, code, x__xgafv=None)
+ Gets one postal code by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ code: string, Postal code ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+}
+list(profileId, x__xgafv=None)
+ Retrieves a list of postal codes.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Postal Code List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
+ "postalCodes": [ # Postal code collection.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one project by ID.
+ +Retrieves a list of projects, possibly filtered. This method supports paging .
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one project by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Planning project.
+ "accountId": "A String", # Account ID of this project.
+ "advertiserId": "A String", # Advertiser ID of this project.
+ "audienceAgeGroup": "A String", # Audience age group of this project.
+ "audienceGender": "A String", # Audience gender of this project.
+ "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
+ "clientBillingCode": "A String", # Client billing code of this project.
+ "clientName": "A String", # Name of the project client.
+ "endDate": "A String",
+ "id": "A String", # ID of this project. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this project.
+ "overview": "A String", # Overview of this project.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this project.
+ "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
+ "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
+ "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
+ "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
+ "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
+ "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
+ "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
+}
+list(profileId, advertiserIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of projects, possibly filtered. This method supports paging .
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
+ ids: string, Select only projects with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Project List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "projects": [ # Project collection.
+ { # Contains properties of a Planning project.
+ "accountId": "A String", # Account ID of this project.
+ "advertiserId": "A String", # Advertiser ID of this project.
+ "audienceAgeGroup": "A String", # Audience age group of this project.
+ "audienceGender": "A String", # Audience gender of this project.
+ "budget": "A String", # Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.
+ "clientBillingCode": "A String", # Client billing code of this project.
+ "clientName": "A String", # Name of the project client.
+ "endDate": "A String",
+ "id": "A String", # ID of this project. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
+ "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
+ "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+ },
+ "name": "A String", # Name of this project.
+ "overview": "A String", # Overview of this project.
+ "startDate": "A String",
+ "subaccountId": "A String", # Subaccount ID of this project.
+ "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
+ "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
+ "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
+ "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
+ "targetCpmActiveViewNanos": "A String", # vCPM from Active View that the advertiser is targeting.
+ "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
+ "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ list(profileId, x__xgafv=None)
Retrieves a list of regions.
+close()
+ Close httplib2 connections.+
list(profileId, x__xgafv=None)
+ Retrieves a list of regions.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Region List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
+ "regions": [ # Region collection.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, remarketingListId, x__xgafv=None)
Gets one remarketing list share by remarketing list ID.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing remarketing list share. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing remarketing list share.
+close()
+ Close httplib2 connections.+
get(profileId, remarketingListId, x__xgafv=None)
+ Gets one remarketing list share by remarketing list ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ remarketingListId: string, Remarketing list ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+ "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+ "A String",
+ ],
+ "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+ "A String",
+ ],
+}
+patch(profileId, id, body=None, x__xgafv=None)
+ Updates an existing remarketing list share. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, RemarketingList ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+ "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+ "A String",
+ ],
+ "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+ "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+ "A String",
+ ],
+ "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+ "A String",
+ ],
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing remarketing list share.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+ "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+ "A String",
+ ],
+ "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+ "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+ "A String",
+ ],
+ "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+ "A String",
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one remarketing list by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new remarketing list.
+ +Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing remarketing list. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing remarketing list.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one remarketing list by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Remarketing list ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new remarketing list.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+list(profileId, advertiserId, active=None, floodlightActivityId=None, maxResults=None, name=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
+ active: boolean, Select only active or only inactive remarketing lists.
+ floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
+ maxResults: integer, Maximum number of results to return.
+ name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Remarketing list response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "remarketingLists": [ # Remarketing list collection.
+ { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing remarketing list. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, RemarketingList ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing remarketing list.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Remarketing list description.
+ "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive.
+ "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+ "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+ "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+ "listPopulationClauses": [ # Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.
+ { # A group clause made up of list population terms representing constraints joined by ORs.
+ "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+ { # Remarketing List Population Rule Term.
+ "contains": True or False, # Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.
+ "negation": True or False, # Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+ "type": "A String", # List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.
+ "value": "A String", # Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ "variableFriendlyName": "A String", # Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.
+ "variableName": "A String", # Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+ },
+ ],
+ },
+ ],
+ },
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this remarketing list was originated.
+ "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+
+ close()
Close httplib2 connections.
+
+ query(profileId, body=None, x__xgafv=None)
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
+close()
+ Close httplib2 connections.+
query(profileId, body=None, x__xgafv=None)
+ Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a response to the queryCompatibleFields method.
+ "crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ },
+ "floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
+ "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#compatibleFields.
+ "pathAttributionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH_ATTRIBUTION".
+ "channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ },
+ "pathReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH". # Contains items that are compatible to be selected for a report of type "PATH".
+ "channelGroupings": [ # Dimensions which are compatible to be selected in the "channelGroupings" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "pathFilters": [ # Dimensions which are compatible to be selected in the "pathFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ },
+ "pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ },
+ "reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
+ "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ },
+ "reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
+ "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+ { # Represents a dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimension.
+ "name": "A String", # The dimension name, e.g. dfa:advertiser
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
+ "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
+ { # Represents a metric.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#metric.
+ "name": "A String", # The metric name, e.g. dfa:impressions
+ },
+ ],
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, reportId, fileId, x__xgafv=None)
Retrieves a report file by its report ID and file ID. This method supports media download.
+
+ get_media(profileId, reportId, fileId, x__xgafv=None)
Retrieves a report file by its report ID and file ID. This method supports media download.
+ +Lists files for a report.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, reportId, fileId, x__xgafv=None)
+ Retrieves a report file by its report ID and file ID. This method supports media download.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ fileId: string, The ID of the report file. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "etag": "A String", # Etag of this resource.
+ "fileName": "A String", # The filename of the file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "id": "A String", # The unique ID of this report file.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "status": "A String", # The status of the report file.
+ "urls": { # The URLs where the completed report file can be downloaded.
+ "apiUrl": "A String", # The URL for downloading the report data through the API.
+ "browserUrl": "A String", # The URL for downloading the report data through a browser.
+ },
+}
+get_media(profileId, reportId, fileId, x__xgafv=None)
+ Retrieves a report file by its report ID and file ID. This method supports media download. + +Args: + profileId: string, The Campaign Manager 360 user profile ID. (required) + reportId: string, The ID of the report. (required) + fileId: string, The ID of the report file. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + The media object as a string. + ++
list(profileId, reportId, maxResults=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Lists files for a report.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ reportId: string, The ID of the parent report. (required)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, The value of the nextToken from the previous result page.
+ sortField: string, The field by which to sort the list.
+ Allowed values
+ ID -
+ LAST_MODIFIED_TIME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List of files for a report.
+ "etag": "A String", # Etag of this resource.
+ "items": [ # The files returned in this response.
+ { # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "etag": "A String", # Etag of this resource.
+ "fileName": "A String", # The filename of the file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "id": "A String", # The unique ID of this report file.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "status": "A String", # The status of the report file.
+ "urls": { # The URLs where the completed report file can be downloaded.
+ "apiUrl": "A String", # The URL for downloading the report data through the API.
+ "browserUrl": "A String", # The URL for downloading the report data through a browser.
+ },
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#fileList".
+ "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
+}
+list_next(previous_request, previous_response)
+ 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. ++
Returns the compatibleFields Resource.
+ +
+ files()
+
Returns the files Resource.
+ +
+ close()
Close httplib2 connections.
+
+ delete(profileId, reportId, x__xgafv=None)
Deletes a report by its ID.
+
+ get(profileId, reportId, x__xgafv=None)
Retrieves a report by its ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Creates a report.
+ +Retrieves list of reports.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, reportId, body=None, x__xgafv=None)
Updates an existing report. This method supports patch semantics.
+
+ run(profileId, reportId, synchronous=None, x__xgafv=None)
Runs a report.
+
+ update(profileId, reportId, body=None, x__xgafv=None)
Updates a report.
+close()
+ Close httplib2 connections.+
delete(profileId, reportId, x__xgafv=None)
+ Deletes a report by its ID. + +Args: + profileId: string, The Campaign Manager 360 user profile ID. (required) + reportId: string, The ID of the report. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, reportId, x__xgafv=None)
+ Retrieves a report by its ID.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Creates a report.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+list(profileId, maxResults=None, pageToken=None, scope=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves list of reports.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, The value of the nextToken from the previous result page.
+ scope: string, The scope that defines which results are returned.
+ Allowed values
+ ALL - All reports in account.
+ MINE - My reports.
+ sortField: string, The field by which to sort the list.
+ Allowed values
+ ID - Sort by report ID.
+ LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
+ NAME - Sort by name of reports.
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the list of reports.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "items": [ # The reports returned in this response.
+ { # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+ },
+ ],
+ "kind": "A String", # The kind of list this is, in this case dfareporting#reportList.
+ "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
+}
+list_next(previous_request, previous_response)
+ 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(profileId, reportId, body=None, x__xgafv=None)
+ Updates an existing report. This method supports patch semantics.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+run(profileId, reportId, synchronous=None, x__xgafv=None)
+ Runs a report.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ synchronous: boolean, If set and true, tries to run the report synchronously.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "etag": "A String", # Etag of this resource.
+ "fileName": "A String", # The filename of the file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "id": "A String", # The unique ID of this report file.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "status": "A String", # The status of the report file.
+ "urls": { # The URLs where the completed report file can be downloaded.
+ "apiUrl": "A String", # The URL for downloading the report data through the API.
+ "browserUrl": "A String", # The URL for downloading the report data through a browser.
+ },
+}
+update(profileId, reportId, body=None, x__xgafv=None)
+ Updates a report.
+
+Args:
+ profileId: string, The Campaign Manager 360 user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "accountId": "A String", # The account ID to which this report belongs.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ },
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimension": "A String", # The dimension option.
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ },
+ "delivery": { # The report's email delivery settings.
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+ "message": "A String", # The message to be sent with each email.
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "deliveryType": "A String", # The delivery type for the recipient.
+ "email": "A String", # The email address of the recipient.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#recipient.
+ },
+ ],
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "fileName": "A String", # The filename used when generating report files for this report.
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reportProperties": { # The properties of the report.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ },
+ },
+ "format": "A String", # The output format of the report. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "id": "A String", # The unique ID identifying this report resource.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#report.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "name": "A String", # The name of the report.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "pathAttributionCriteria": { # The report criteria for a report of type "PATH_ATTRIBUTION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathCriteria": { # The report criteria for a report of type "PATH".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customChannelGrouping": { # Represents a DfaReporting channel grouping. # Channel Grouping.
+ "fallbackName": "A String", # ChannelGrouping fallback name.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGrouping.
+ "name": "A String", # ChannelGrouping name.
+ "rules": [ # The rules contained within this channel grouping.
+ { # Represents a DfaReporting channel grouping rule.
+ "disjunctiveMatchStatements": [ # The disjunctive match statements contained within this rule.
+ { # Represents a Disjunctive Match Statement resource, which is a conjunction (and) of disjunctive (or) boolean statements.
+ "eventFilters": [ # The event filters contained within this disjunctive match statement.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#channelGroupingRule.
+ "name": "A String", # Rule name.
+ },
+ ],
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "pathFilters": [ # Path Filters.
+ { # Represents a DfaReporting path filter.
+ "eventFilters": [ # Event filters in path report.
+ { # Represents a DfaReporting event filter.
+ "dimensionFilter": { # Represents a PathReportDimensionValue resource. # The dimension filter contained within this EventFilter.
+ "dimensionName": "A String", # The name of the dimension.
+ "ids": [ # The possible ID's associated with the value if available.
+ "A String",
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathReportDimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "values": [ # The possible values of the dimension.
+ "A String",
+ ],
+ },
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#eventFilter.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#pathFilter.
+ "pathMatchPosition": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ },
+ ],
+ },
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "customRichMediaEvents": [ # The list of custom rich media events to include.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # CM360 checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "impressionsLookbackWindow": 42, # CM360 checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ },
+ },
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#activities.
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ },
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "endDate": "A String",
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange.
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+ "startDate": "A String",
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column.
+ },
+ ],
+ "enableAllDimensionCombinations": True or False, # Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last 42 days.
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ },
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String",
+ "repeats": "A String", # The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "startDate": "A String",
+ },
+ "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+ "type": "A String", # The type of the report.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one site by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new site.
+ +Retrieves a list of sites, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing site. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing site.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one site by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Site ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new site.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, adWordsSite=None, approved=None, campaignIds=None, directorySiteIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, unmappedSite=None, x__xgafv=None)
+ Retrieves a list of sites, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+ acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+ acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
+ adWordsSite: boolean, Select only AdWords sites.
+ approved: boolean, Select only approved sites.
+ campaignIds: string, Select only sites with these campaign IDs. (repeated)
+ directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
+ ids: string, Select only sites with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ subaccountId: string, Select only sites with this subaccount ID.
+ unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Site List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "sites": [ # Site collection.
+ { # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing site. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Site ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing site.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a site.
+ "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+ "approved": True or False, # Whether this site is approved.
+ "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+ "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+ "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+ "name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
+ "siteContacts": [ # Site contacts.
+ { # Site Contact
+ "address": "A String", # Address of this site contact.
+ "contactType": "A String", # Site contact type.
+ "email": "A String", # Email address of this site contact. This is a required field.
+ "firstName": "A String", # First name of this site contact.
+ "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+ "lastName": "A String", # Last name of this site contact.
+ "phone": "A String", # Primary phone number of this site contact.
+ "title": "A String", # Title or designation of this site contact.
+ },
+ ],
+ "siteSettings": { # Site Settings # Site-wide settings.
+ "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+ "adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
+ "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+ "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+ "additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
+ "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+ "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+ "keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
+ },
+ "videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
+ "vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
+ },
+ "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+ "videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
+ "companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
+ "companionsDisabled": True or False, # Whether companions are disabled for this site template.
+ "enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+ "imageOnly": True or False, # Whether to serve only static images as companions.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
+ "obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
+ "obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
+ "iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
+ "iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
+ "iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
+ "program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
+ "resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
+ "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
+ "yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
+ },
+ "orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
+ "skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
+ "progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
+ "offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
+ "offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
+ },
+ "skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
+ },
+ "transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
+ "enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
+ 42,
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
+ },
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one size by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new size.
+
+ list(profileId, height=None, iabStandard=None, ids=None, width=None, x__xgafv=None)
Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one size by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Size ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new size.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+}
+list(profileId, height=None, iabStandard=None, ids=None, width=None, x__xgafv=None)
+ Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ height: integer, Select only sizes with this height.
+ iabStandard: boolean, Select only IAB standard sizes.
+ ids: string, Select only sizes with these IDs. (repeated)
+ width: integer, Select only sizes with this width.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Size List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
+ "sizes": [ # Size collection.
+ { # Represents the dimensions of ads, placements, creatives, or creative assets.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one subaccount by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new subaccount.
+ +Gets a list of subaccounts, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing subaccount. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing subaccount.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one subaccount by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Subaccount ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new subaccount.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Gets a list of subaccounts, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Select only subaccounts with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" .
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Subaccount List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "subaccounts": [ # Subaccount collection.
+ { # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing subaccount. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Subaccount ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing subaccount.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a Campaign Manager subaccount.
+ "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+ "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+ "A String",
+ ],
+ "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+ "name": "A String", # Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one remarketing list by ID.
+ +Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one remarketing list by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Remarketing list ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this targetable remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Targetable remarketing list description.
+ "id": "A String", # Targetable remarketing list ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this targetable remarketing list was originated.
+ "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+}
+list(profileId, advertiserId, active=None, maxResults=None, name=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
+ active: boolean, Select only active or only inactive targetable remarketing lists.
+ maxResults: integer, Maximum number of results to return.
+ name: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Targetable remarketing list response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "targetableRemarketingLists": [ # Targetable remarketing list collection.
+ { # Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.
+ "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ "active": True or False, # Whether this targetable remarketing list is active.
+ "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "description": "A String", # Targetable remarketing list description.
+ "id": "A String", # Targetable remarketing list ID.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
+ "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
+ "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+ "listSource": "A String", # Product from which this targetable remarketing list was originated.
+ "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
+ "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one targeting template by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new targeting template.
+ +Retrieves a list of targeting templates, optionally filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing targeting template. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing targeting template.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one targeting template by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, Targeting template ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new targeting template.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+list(profileId, advertiserId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)
+ Retrieves a list of targeting templates, optionally filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ advertiserId: string, Select only targeting templates with this advertiser ID.
+ ids: string, Select only targeting templates with these IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Targeting Template List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplatesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "targetingTemplates": [ # Targeting template collection.
+ { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing targeting template. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, TargetingTemplate ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing targeting template.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a targeting template. A targeting template encapsulates targeting information which can be reused across multiple ads.
+ "accountId": "A String", # Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "advertiserId": "A String", # Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert.
+ "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+ "dimensionName": "A String", # The name of the dimension.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
+ "value": "A String", # The value of the dimension.
+ },
+ "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
+ "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
+ "A String",
+ ],
+ "hoursOfDay": [ # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is 11 PM to midnight. Can be specified with days of week, in which case the ad would serve during these hours on the specified days. For example if Monday, Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive.
+ 42,
+ ],
+ "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+ },
+ "geoTargeting": { # Geographical Targeting. # Geographical targeting criteria.
+ "cities": [ # Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city.
+ { # Contains information about a city that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this city belongs.
+ "countryDartId": "A String", # DART ID of the country to which this city belongs.
+ "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+ "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+ "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+ "name": "A String", # Name of this city.
+ "regionCode": "A String", # Region code of the region to which this city belongs.
+ "regionDartId": "A String", # DART ID of the region to which this city belongs.
+ },
+ ],
+ "countries": [ # Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country.
+ { # Contains information about a country that can be targeted by ads.
+ "countryCode": "A String", # Country code.
+ "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+ "name": "A String", # Name of this country.
+ "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+ },
+ ],
+ "excludeCountries": True or False, # Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad.
+ "metros": [ # Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro.
+ { # Contains information about a metro region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this metro region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+ "dartId": "A String", # DART ID of this metro region.
+ "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+ "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+ "name": "A String", # Name of this metro region.
+ },
+ ],
+ "postalCodes": [ # Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code.
+ { # Contains information about a postal code that can be targeted by ads.
+ "code": "A String", # Postal code. This is equivalent to the id field.
+ "countryCode": "A String", # Country code of the country to which this postal code belongs.
+ "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+ "id": "A String", # ID of this postal code.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+ },
+ ],
+ "regions": [ # Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region.
+ { # Contains information about a region that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this region belongs.
+ "countryDartId": "A String", # DART ID of the country to which this region belongs.
+ "dartId": "A String", # DART ID of this region.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+ "name": "A String", # Name of this region.
+ "regionCode": "A String", # Region code.
+ },
+ ],
+ },
+ "id": "A String", # ID of this targeting template. This is a read-only, auto-generated field.
+ "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting criteria.
+ "expression": "A String", # Keyword expression being targeted by the ad.
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate".
+ "languageTargeting": { # Language Targeting. # Language targeting criteria.
+ "languages": [ # Languages that this ad targets. For each language only languageId is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a language that can be targeted by ads.
+ "id": "A String", # Language ID of this language. This is the ID used for targeting and generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#language".
+ "languageCode": "A String", # Format of language code is an ISO 639 two-letter language code optionally followed by an underscore followed by an ISO 3166 code. Examples are "en" for English or "zh_CN" for Simplified Chinese.
+ "name": "A String", # Name of this language.
+ },
+ ],
+ },
+ "listTargetingExpression": { # Remarketing List Targeting Expression. # Remarketing list targeting criteria.
+ "expression": "A String", # Expression describing which lists are being targeted by the ad.
+ },
+ "name": "A String", # Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser.
+ "subaccountId": "A String", # Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert.
+ "technologyTargeting": { # Technology Targeting. # Technology platform targeting criteria.
+ "browsers": [ # Browsers that this ad targets. For each browser either set browserVersionId or dartId along with the version numbers. If both are specified, only browserVersionId will be used. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a browser that can be targeted by ads.
+ "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+ "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+ "majorVersion": "A String", # Major version number (leftmost number) of this browser. For example, for Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "minorVersion": "A String", # Minor version number (number after first dot on left) of this browser. For example, for Chrome 5.0.375.86 beta, this field should be set to 0. An asterisk (*) may be used to target any version number, and a question mark (?) may be used to target cases where the version number cannot be identified. For example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad server knows the browser is Firefox but can't tell which version it is.
+ "name": "A String", # Name of this browser.
+ },
+ ],
+ "connectionTypes": [ # Connection types that this ad targets. For each connection type only id is required. The other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about an internet connection type that can be targeted by ads. Clients can use the connection type to target mobile vs. broadband users.
+ "id": "A String", # ID of this connection type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+ "name": "A String", # Name of this connection type.
+ },
+ ],
+ "mobileCarriers": [ # Mobile carriers that this ad targets. For each mobile carrier only id is required, and the other fields are populated automatically when the ad is inserted or updated. If targeting a mobile carrier, do not set targeting for any zip codes.
+ { # Contains information about a mobile carrier that can be targeted by ads.
+ "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+ "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+ "id": "A String", # ID of this mobile carrier.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+ "name": "A String", # Name of this mobile carrier.
+ },
+ ],
+ "operatingSystemVersions": [ # Operating system versions that this ad targets. To target all versions, use operatingSystems. For each operating system version, only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system version, do not set targeting for the corresponding operating system in operatingSystems.
+ { # Contains information about a particular version of an operating system that can be targeted by ads.
+ "id": "A String", # ID of this operating system version.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+ "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+ "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+ "name": "A String", # Name of this operating system version.
+ "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ },
+ ],
+ "operatingSystems": [ # Operating systems that this ad targets. To target specific versions, use operatingSystemVersions. For each operating system only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting an operating system, do not set targeting for operating system versions for the same operating system.
+ { # Contains information about an operating system that can be targeted by ads.
+ "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+ "desktop": True or False, # Whether this operating system is for desktop.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+ "mobile": True or False, # Whether this operating system is for mobile.
+ "name": "A String", # Name of this operating system.
+ },
+ ],
+ "platformTypes": [ # Platform types that this ad targets. For example, desktop, mobile, or tablet. For each platform type, only id is required, and the other fields are populated automatically when the ad is inserted or updated.
+ { # Contains information about a platform type that can be targeted by ads.
+ "id": "A String", # ID of this platform type.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+ "name": "A String", # Name of this platform type.
+ },
+ ],
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, x__xgafv=None)
Gets one user profile by ID.
+ +Retrieves list of user profiles for a user.
+close()
+ Close httplib2 connections.+
get(profileId, x__xgafv=None)
+ Gets one user profile by ID.
+
+Args:
+ profileId: string, The user profile ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests.
+ "accountId": "A String", # The account ID to which this profile belongs.
+ "accountName": "A String", # The account name this profile belongs to.
+ "etag": "A String", # Etag of this resource.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userProfile".
+ "profileId": "A String", # The unique ID of the user profile.
+ "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
+ "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
+ "userName": "A String", # The user name.
+}
+list(x__xgafv=None)
+ Retrieves list of user profiles for a user.
+
+Args:
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the list of user profiles.
+ "etag": "A String", # Etag of this resource.
+ "items": [ # The user profiles returned in this response.
+ { # A UserProfile resource lets you list all DFA user profiles that are associated with a Google user account. The profile_id needs to be specified in other API requests.
+ "accountId": "A String", # The account ID to which this profile belongs.
+ "accountName": "A String", # The account name this profile belongs to.
+ "etag": "A String", # Etag of this resource.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userProfile".
+ "profileId": "A String", # The unique ID of the user profile.
+ "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
+ "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
+ "userName": "A String", # The user name.
+ },
+ ],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userProfileList".
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one user role permission group by ID.
+
+ list(profileId, x__xgafv=None)
Gets a list of all supported user role permission groups.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one user role permission group by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, User role permission group ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a grouping of related user role permissions.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
+ "name": "A String", # Name of this user role permission group.
+}
+list(profileId, x__xgafv=None)
+ Gets a list of all supported user role permission groups.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # User Role Permission Group List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
+ "userRolePermissionGroups": [ # User role permission group collection.
+ { # Represents a grouping of related user role permissions.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
+ "name": "A String", # Name of this user role permission group.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one user role permission by ID.
+
+ list(profileId, ids=None, x__xgafv=None)
Gets a list of user role permissions, possibly filtered.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one user role permission by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, User role permission ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+}
+list(profileId, ids=None, x__xgafv=None)
+ Gets a list of user role permissions, possibly filtered.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ ids: string, Select only user role permissions with these IDs. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # User Role Permission List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
+ "userRolePermissions": [ # User role permission collection.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+}
+
+ close()
Close httplib2 connections.
+
+ delete(profileId, id, x__xgafv=None)
Deletes an existing user role.
+
+ get(profileId, id, x__xgafv=None)
Gets one user role by ID.
+
+ insert(profileId, body=None, x__xgafv=None)
Inserts a new user role.
+ +Retrieves a list of user roles, possibly filtered. This method supports paging.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(profileId, id, body=None, x__xgafv=None)
Updates an existing user role. This method supports patch semantics.
+
+ update(profileId, body=None, x__xgafv=None)
Updates an existing user role.
+close()
+ Close httplib2 connections.+
delete(profileId, id, x__xgafv=None)
+ Deletes an existing user role. + +Args: + profileId: string, User profile ID associated with this request. (required) + id: string, User role ID. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(profileId, id, x__xgafv=None)
+ Gets one user role by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, User role ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+insert(profileId, body=None, x__xgafv=None)
+ Inserts a new user role.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+list(profileId, accountUserRoleOnly=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)
+ Retrieves a list of user roles, possibly filtered. This method supports paging.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
+ ids: string, Select only user roles with the specified IDs. (repeated)
+ maxResults: integer, Maximum number of results to return.
+ pageToken: string, Value of the nextPageToken from the previous result page.
+ searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
+ sortField: string, Field by which to sort the list.
+ Allowed values
+ ID -
+ NAME -
+ sortOrder: string, Order of sorted results.
+ Allowed values
+ ASCENDING -
+ DESCENDING -
+ subaccountId: string, Select only user roles that belong to this subaccount.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # User Role List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
+ "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+ "userRoles": [ # User role collection.
+ { # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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(profileId, id, body=None, x__xgafv=None)
+ Updates an existing user role. This method supports patch semantics.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: string, UserRole ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+update(profileId, body=None, x__xgafv=None)
+ Updates an existing user role.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains properties of auser role, which is used to manage user access.
+ "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+ "defaultUserRole": True or False, # Whether this is a default user role. Default user roles are created by the system for the account/subaccount and cannot be modified or deleted. Each default user role comes with a basic set of preassigned permissions.
+ "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+ "name": "A String", # Name of this user role. This is a required field. Must be less than 256 characters long. If this user role is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this user role is a top-level user role, and the name must be unique among top-level user roles of the same account.
+ "parentUserRoleId": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+ "permissions": [ # List of permissions associated with this user role.
+ { # Contains properties of a user role permission.
+ "availability": "A String", # Levels of availability for a user role permission.
+ "id": "A String", # ID of this user role permission.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+ "name": "A String", # Name of this user role permission.
+ "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+ },
+ ],
+ "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+}
+
+ close()
Close httplib2 connections.
+
+ get(profileId, id, x__xgafv=None)
Gets one video format by ID.
+
+ list(profileId, x__xgafv=None)
Lists available video formats.
+close()
+ Close httplib2 connections.+
get(profileId, id, x__xgafv=None)
+ Gets one video format by ID.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ id: integer, Video format ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains information about supported video formats.
+ "fileType": "A String", # File type of the video format.
+ "id": 42, # ID of the video format.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat".
+ "resolution": { # Represents the dimensions of ads, placements, creatives, or creative assets. # The resolution of this video format.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "targetBitRate": 42, # The target bit rate of this video format.
+}
+list(profileId, x__xgafv=None)
+ Lists available video formats.
+
+Args:
+ profileId: string, User profile ID associated with this request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Video Format List Response
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormatsListResponse".
+ "videoFormats": [ # Video format collection.
+ { # Contains information about supported video formats.
+ "fileType": "A String", # File type of the video format.
+ "id": 42, # ID of the video format.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoFormat".
+ "resolution": { # Represents the dimensions of ads, placements, creatives, or creative assets. # The resolution of this video format.
+ "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
+ "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+ "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+ "width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
+ },
+ "targetBitRate": 42, # The target bit rate of this video format.
+ },
+ ],
+}
+