Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes asset groups. Operation statuses are returned.
close()
Close httplib2 connections.
mutate(customerId, body=None, x__xgafv=None)
Creates, updates or removes asset groups. Operation statuses are returned.
Args:
customerId: string, Required. The ID of the customer whose asset groups are being modified. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for AssetGroupService.MutateAssetGroups.
"operations": [ # Required. The list of operations to perform on individual asset groups.
{ # A single operation (create, remove) on an asset group.
"create": { # An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group. # Create operation: No resource name is expected for the new asset group
"adStrength": "A String", # Output only. Overall ad strength of this asset group.
"assetCoverage": { # Information about the asset coverage of an asset group. # Output only. The asset coverage of this asset group.
"adStrengthActionItems": [ # Output only. A list of action items to improve the ad strength of an asset group.
{ # An action item to improve the ad strength of an asset group.
"actionItemType": "A String", # Output only. The action item type.
"addAssetDetails": { # The details of the asset to add. # Output only. The action item details for action item type ADD_ASSET.
"assetCount": 42, # Output only. The number of assets to add.
"assetFieldType": "A String", # Output only. The asset field type of the asset(s) to add.
"videoAspectRatioRequirement": "A String", # Output only. For video field types, the required aspect ratio of the video. When unset and asset_field_type is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.
},
},
],
},
"campaign": "A String", # Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
"finalMobileUrls": [ # A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"finalUrls": [ # A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"id": "A String", # Output only. The ID of the asset group.
"name": "A String", # Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
"path1": "A String", # First part of text that may appear appended to the url displayed in the ad.
"path2": "A String", # Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
"primaryStatus": "A String", # Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
"primaryStatusReasons": [ # Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
"A String",
],
"resourceName": "A String", # Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
"status": "A String", # The status of the asset group.
},
"remove": "A String", # Remove operation: A resource name for the removed asset group is expected, in this format: `customers/{customer_id}/assetGroups/{asset_group_id}`
"update": { # An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group. # Update operation: The asset group is expected to have a valid resource name.
"adStrength": "A String", # Output only. Overall ad strength of this asset group.
"assetCoverage": { # Information about the asset coverage of an asset group. # Output only. The asset coverage of this asset group.
"adStrengthActionItems": [ # Output only. A list of action items to improve the ad strength of an asset group.
{ # An action item to improve the ad strength of an asset group.
"actionItemType": "A String", # Output only. The action item type.
"addAssetDetails": { # The details of the asset to add. # Output only. The action item details for action item type ADD_ASSET.
"assetCount": 42, # Output only. The number of assets to add.
"assetFieldType": "A String", # Output only. The asset field type of the asset(s) to add.
"videoAspectRatioRequirement": "A String", # Output only. For video field types, the required aspect ratio of the video. When unset and asset_field_type is YOUTUBE_VIDEO, the system recommends the advertiser upload any YouTube video, regardless of aspect ratio.
},
},
],
},
"campaign": "A String", # Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.
"finalMobileUrls": [ # A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"finalUrls": [ # A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.
"A String",
],
"id": "A String", # Output only. The ID of the asset group.
"name": "A String", # Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.
"path1": "A String", # First part of text that may appear appended to the url displayed in the ad.
"path2": "A String", # Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.
"primaryStatus": "A String", # Output only. The primary status of the asset group. Provides insights into why an asset group is not serving or not serving optimally.
"primaryStatusReasons": [ # Output only. Provides reasons into why an asset group is not serving or not serving optimally. It will be empty when the asset group is serving without issues.
"A String",
],
"resourceName": "A String", # Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`
"status": "A String", # The status of the asset group.
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for an asset group mutate.
"partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"results": [ # All results for the mutate.
{ # The result for the asset group mutate.
"resourceName": "A String", # Returned for successful operations.
},
],
}