Method: customers.generateShareablePreviews

Returns the requested Shareable Preview.

HTTP request

POST https://googleads.googleapis.com/v18/customers/{customerId}:generateShareablePreviews

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The customer creating the shareable previews request.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "shareablePreviews": [
    {
      object (ShareablePreview)
    }
  ]
}
Fields
shareablePreviews[]

object (ShareablePreview)

Required. The list of shareable previews to generate.

Response body

Response message for ShareablePreviewService.GenerateShareablePreviews.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "responses": [
    {
      object (ShareablePreviewOrError)
    }
  ]
}
Fields
responses[]

object (ShareablePreviewOrError)

List of generate shareable preview results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

ShareablePreview

A shareable preview with its identifier.

JSON representation 
{
  "assetGroupIdentifier": {
    object (AssetGroupIdentifier)
  }
}
Fields
assetGroupIdentifier

object (AssetGroupIdentifier)

Required. Asset group of the shareable preview.

AssetGroupIdentifier

Asset group of the shareable preview.

JSON representation 
{
  "assetGroupId": string
}
Fields
assetGroupId

string (int64 format)

Required. The asset group identifier.

ShareablePreviewOrError

Result of the generate shareable preview.

JSON representation 
{
  "assetGroupIdentifier": {
    object (AssetGroupIdentifier)
  },

  // Union field generate_shareable_preview_response can be only one of the
  // following:
  "shareablePreviewResult": {
    object (ShareablePreviewResult)
  },
  "partialFailureError": {
    object (Status)
  }
  // End of list of possible types for union field
  // generate_shareable_preview_response.
}
Fields
assetGroupIdentifier

object (AssetGroupIdentifier)

The asset group of the shareable preview.
Union field generate_shareable_preview_response. The shareable preview result or error. generate_shareable_preview_response can be only one of the following:
shareablePreviewResult

object (ShareablePreviewResult)

The shareable preview result.
partialFailureError

object (Status)

The shareable preview partial failure error.

ShareablePreviewResult

Message to hold a shareable preview result.

JSON representation 
{
  "shareablePreviewUrl": string,
  "expirationDateTime": string
}
Fields
shareablePreviewUrl

string

The shareable preview URL.
expirationDateTime

string

Expiration date time using the ISO-8601 format.