View Source GoogleApi.Content.V21.Api.Collectionstatuses (google_api_content v0.66.0)
API calls for all endpoints tagged Collectionstatuses
.
Summary
Functions
Gets the status of a collection from your Merchant Center account.
Lists the statuses of the collections in your Merchant Center account.
Functions
Link to this function
content_collectionstatuses_get(connection, merchant_id, collection_id, optional_params \\ [], opts \\ [])
View Source@spec content_collectionstatuses_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.CollectionStatus.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the status of a collection from your Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - Required. The ID of the account that contains the collection. This account cannot be a multi-client account. -
collection_id
(type:String.t
) - Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V21.Model.CollectionStatus{}}
on success -
{:error, info}
on failure
Link to this function
content_collectionstatuses_list(connection, merchant_id, optional_params \\ [], opts \\ [])
View Source@spec content_collectionstatuses_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Content.V21.Model.ListCollectionStatusesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the statuses of the collections in your Merchant Center account.
Parameters
-
connection
(type:GoogleApi.Content.V21.Connection.t
) - Connection to server -
merchant_id
(type:String.t
) - Required. The ID of the account that contains the collection. This account cannot be a multi-client account. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000. -
:pageToken
(type:String.t
) - Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Content.V21.Model.ListCollectionStatusesResponse{}}
on success -
{:error, info}
on failure